ai-toolkit

module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2026 License: MIT

README

ai-toolkit

Go Reference

A personal, highly opinionated set of Go packages for working with chat-based LLMs. It's built for my own use and reflects my own taste in API design — there are more mature, better-supported libraries out there, and you should probably reach for one of those first. But if it happens to fit your needs as-is, feel free to use it.

Requires Go 1.26.5+. Supported providers: OpenRouter, Ollama, and Anthropic.

go get github.com/jjmrocha/ai-toolkit
Package What it does Builds on
llm One chat API across three providers
helper Building blocks shared across the toolkit
tools Registers tools and dispatches the model's calls llm
mcp Turns an MCP server's tools into tools entries helper, llm, tools
skills On-demand instructions the model loads by name helper, llm, tools
agent Runs the call-tool-feed-back loop for you llm, tools, skills

The sections below are a tour. The full API reference lives on pkg.go.dev.

llm

One API for chatting with OpenRouter, Ollama, or Anthropic — swap Provider and Model to change backends.

model, err := llm.New(llm.Config{
	Provider: llm.ProviderOpenRouter,
	APIKey:   os.Getenv("OPENROUTER_API_KEY"),
	Model:    "openai/gpt-4o",
})
if err != nil {
	log.Fatal(err)
}

reply, err := model.Chat(context.Background(), []llm.Message{
	llm.SystemMessage{Content: "You are concise."},
	llm.UserMessage{Content: "What is the capital of Portugal?"},
}, nil)
if err != nil {
	log.Fatal(err)
}

fmt.Println(reply.Content)
fmt.Printf("tokens: %d\n", reply.Stats.TotalTokens)

Worth knowing:

  • Ollama needs no API key.
  • Every reply carries Stats — including prompt-cache reads and writes — and the provider's native StopReason.
  • Config.Effort maps one knob, EffortOff through EffortMax, onto Anthropic's thinking-token budget and OpenRouter/Ollama's reasoning level.
  • Config.Models lists what ChangeModel may switch to mid-conversation; the active model is always included.

helper

Pieces the rest of the toolkit shares, and that are useful on their own.

Process

Runs a child process and delivers its output one line at a time. It owns the child's whole life: start, read, write to stdin, and a shutdown that tries SIGTERM before SIGKILL and waits for the process to be reaped.

process, err := helper.NewProcess(helper.ProcessConfig{
	Path:          "./report.sh",
	Args:          []string{"--since", "monday"},
	Dir:           "/srv/reports",
	IncludeStderr: true,
	OnExit:        func(err error) { log.Println("finished:", err) },
})
if err != nil {
	log.Fatal(err)
}

defer process.Close()

for line := range process.Output() {
	fmt.Println(line)
}

Worth knowing:

  • IncludeStderr decides what Output carries. Unset, it carries stdout alone and stderr is discarded — what a process speaking a line protocol over stdout wants. Set, stdout and stderr share a single pipe, so lines arrive in the order the process wrote them — what capturing a script's output wants.
  • Sharing one pipe is what makes the ordering real rather than reconstructed: the kernel interleaves the two streams. Two separate pipes could not put them back in order afterwards.
  • Blank lines are delivered like any other line.
  • MaxLineBytes bounds a single line; a longer one ends the stream, Output closes, and the process is stopped. Left zero there is no limit, so a process that never writes a newline grows the read buffer until memory runs out.
  • OnExit is called once with the result of waiting on the process. An exit status is recovered from it with errors.As on an *exec.ExitError.
  • AllowInput decides whether the process gets a stdin at all. Without it the process reads from the null device, so anything waiting on input sees end of input at once rather than hanging.
  • Write sends one line to the process's stdin. A message containing a newline is rejected with ErrInvalidMessage, writing to a process built without AllowInput returns ErrInputNotAllowed, and writing to a process that has gone returns ErrProcessClosed.
  • Close is safe to call more than once, and must be called even when the process exits on its own.
  • Path and Args are run without a shell, so they are trusted input: the process runs with the same authority as the program that started it.
Run

Runs a command to completion and hands back what it wrote and the status it exited with.

result, err := helper.Run(ctx, helper.RunConfig{
	Path: "./report.sh",
	Args: []string{"--since", "monday"},
	Dir:  "/srv/reports",
})
if err != nil {
	log.Fatal(err)
}

fmt.Println(result.ExitCode, strings.Join(result.Output, "\n"))

Worth knowing:

  • A non-zero exit status is part of the Result, not an error. Run returns an error only when the command could not be started, when ctx ended first, or when waiting on it failed for some other reason.
  • ctx cancels the run: the command is sent SIGTERM, then SIGKILL if it does not go.
  • The command's stderr is always merged into the output, in the order it was written. Reach for NewProcess to read stdout on its own.
  • MaxOutputBytes is how much output Run collects before stopping the command, counting each line plus its newline. The line that passes the limit is kept, so the result can run over by that much. Truncated is set. Left zero, everything is collected and only ctx bounds the run.
  • A stopped command's ExitCode describes the kill, not a choice it made — unless it had already finished, in which case its own status survives.

tools

Removes the two chores of tool calling: writing parameter schemas by hand and dispatching the model's calls yourself.

toolBox := tools.NewToolBox()

toolBox.Add(
	llm.Tool{
		Name:        "get_weather",
		Description: "Get the current weather for a city",
		Schema: tools.NewObjectBuilder().
			String("city", "the city to look up", true).
			Build(),
	},
	func(ctx context.Context, args map[string]any) (string, error) {
		city, err := tools.NewArguments(args).GetString("city")
		if err != nil {
			return "", err
		}
		return weatherFor(ctx, city) // your code
	},
)

reply, err := model.Chat(ctx, messages, toolBox.Tools())
// ...
for _, call := range reply.ToolCalls {
	msg, err := toolBox.Execute(ctx, call) // looks up and runs the handler
	if err != nil {
		return err
	}
	messages = append(messages, *msg)
}

Worth knowing:

  • Tools returns a name-sorted slice, so the tool section of the prompt stays byte-identical across requests — which is what prompt caching needs.
  • A ToolBox is safe for concurrent use: tools can be added and removed while other goroutines list or execute them.
  • ObjectBuilder nests — pass one to Object or ArrayOfObjects to describe schemas of any depth.
  • Arguments accessors return ErrFieldNotFound or ErrInvalidFieldType instead of panicking, and take an int where JSON handed you a float64.
  • ValidToolName and SanitizeToolName apply the providers' naming rules (64 characters; letters, digits, _, -) to names from outside sources.

mcp

Connects a stdio-based MCP server to a tools.ToolBox, so the tools it exposes become callable like any other tool.

toolBox := tools.NewToolBox()

mcpClient, err := mcp.NewClient(ctx, mcp.ClientConfig{
	Name:    "playwright",
	Command: "npx",
	Args:    []string{"@playwright/mcp@latest"},
})
if err != nil {
	log.Fatal(err)
}
defer mcpClient.Close()

if err := mcpClient.RegisterTools(ctx, toolBox); err != nil {
	log.Fatal(err)
}

reply, err := model.Chat(ctx, messages, toolBox.Tools()) // MCP tools included

Worth knowing:

  • Tools are namespaced "<Name>__<tool>", e.g. playwright__browser_navigate. A namespaced name the providers would reject is rewritten rather than dropped; the server is still called by the name it published.
  • Requests are matched to responses by id, so several may be in flight at once. One blocked on a silent server returns when its context is cancelled or its deadline expires.
  • Close shuts the process down and removes the tools it registered, aborting any call still waiting on the server.
  • Command and Args are run without a shell, but they are still trusted input: supply them from operator configuration, never from an untrusted source.
Manager

Runs several MCP servers on demand against a shared ToolBox — for example, to expose a server's tools only while a user has it switched on.

manager := mcp.NewManager(toolBox)
manager.Register(mcp.ClientConfig{
	Name:    "playwright",
	Command: "npx",
	Args:    []string{"@playwright/mcp@latest"},
})
defer manager.Close()

if err := manager.Start(ctx, "playwright"); err != nil {
	log.Fatal(err)
}

for _, status := range manager.Status() {
	fmt.Printf("%s active=%t\n", status.Name, status.Active)
}

manager.Stop("playwright") // tools removed, config kept for a later Start

Register records a launch configuration without starting it. Start and Stop bring a server up and down by name, keeping the configuration for a later restart; a server whose process has died is replaced on the next Start. Status reports which are running and Close stops everything. Safe for concurrent use.

skills

A skill is a folder with a SKILL.md inside: frontmatter carrying a name and a description, and a body holding the instructions. You add the folders a session should have — nothing is discovered automatically.

collection := skills.NewCollection()
if err := collection.Add("./skills/git-release"); err != nil {
	log.Fatal(err)
}
---
name: git-release
description: Draft release notes and propose a version bump
---

Read the merged PRs since the last tag, then ...

Worth knowing:

  • Only names and descriptions reach the model up front, as an <available_skills> block appended to the session's system prompt. Bodies load on demand, so a long skill costs nothing until it is used.
  • Three tools are registered for the session: skill_load returns a skill's instructions plus the list of files it ships, skill_load_file returns one of those files, and skill_execute_file runs one of them.
  • skill_load, skill_load_file and skill_execute_file are reserved tool names. A tool already registered under any of them is replaced while the session lasts, and removed when it ends.
  • An agent wires the collection up on StartSession; on its own, RegisterTools adds the three tools to any ToolBox and UnregisterTools takes them back out. Catalog renders the <available_skills> block, and Skills lists the names added so far, sorted.
  • File access is confined to the skill folder with os.OpenRoot, so a symlink pointing outside it is neither listed nor readable, and the model is never told the folder's real path.
  • skill_execute_file runs the file directly, from the skill's folder, with the arguments the model supplies and no shell. The file needs its own execute bit and shebang; the package never changes file modes, and it infers no interpreter from the extension. A file the skill does not ship cannot be run.
  • A non-zero exit is a result, not a failure: the tool returns the process's combined output and its exit status, and reports an error only when the process could not run at all.
  • Output is collected up to 1 MiB, after which the script is stopped and the result is marked truncated. A stopped script's exit status describes the kill rather than a choice it made.
  • The script gets no stdin, so one that reads input sees end of input at once instead of waiting.
  • Execution honours the context passed to Process and nothing else — there is no built-in timeout. It also leaves the os.OpenRoot sandbox behind: the process runs with the same authority as the program that started it and inherits its environment, credentials included, so add only folders you trust, exactly as with an mcp server command.
  • The body and the file list are read once, by Add. Editing a skill on disk does not change a collection already built.
  • Frontmatter keys other than name and description are ignored. Values must be single-line; a folded or literal block scalar is rejected with ErrInvalidFrontmatter.
  • The catalog is sorted by name, so the system prompt stays byte-identical across sessions built from the same collection — which is what prompt caching needs.

agent

Ties llm and tools into a conversation loop: send user input, run whatever tools the model asks for, feed the results back, and repeat until the model returns a final answer — so you don't write that loop yourself.

agt, err := agent.New(agent.Config{MaxIterations: 10}, model)
if err != nil {
	log.Fatal(err)
}
defer agt.Close()

agt.StartSession(agent.SessionConfig{
	Prompt:  "You are a helpful weather assistant.",
	ToolBox: toolBox,
	Skills:  collection,
})

resp, err := agt.Process(ctx, "What should I wear in Lisbon today?")
if err != nil {
	log.Fatal(err)
}

fmt.Println(resp.Content)
fmt.Printf("%d tool calls, %d tokens\n",
	resp.Metadata.ToolCalls, resp.Metadata.TotalTokens)

Worth knowing:

  • A failing tool is reported back to the model as its error text, so the model can recover instead of the turn aborting.
  • Once a completed turn crosses Config.CompactionThresholdPercent of the model's context window (85% by default), the older turns are summarized into a single message while the system prompt and recent turns are kept verbatim.
  • Config.MaxIterations caps the model/tool rounds per Process call; zero means no limit, and hitting the cap returns ErrMaxIterations.
  • Response.Metadata reports token usage, stop reason, per-phase timing, and iteration and tool-call counts.
  • StartSession declares everything the model sees: the system prompt, the ToolBox it may call, and the skills.Collection it may load from. All three last until Close or the next StartSession, so one agent can run differently equipped sessions.
  • A SessionConfig.Skills collection has its tools registered in the session's ToolBox and its catalog appended to the prompt; Close removes those tools again.
  • Install a Feedback sink with SetFeedback to observe tool calls and session events; the default is silent.

License

MIT — see LICENSE.

Directories

Path Synopsis
Package agent drives a multi-turn, tool-calling conversation with an LLM.
Package agent drives a multi-turn, tool-calling conversation with an LLM.
Package helper holds the building blocks the rest of the toolkit shares, and that a caller may reach for directly.
Package helper holds the building blocks the rest of the toolkit shares, and that a caller may reach for directly.
Package llm provides a provider-agnostic client for chat-based large language models.
Package llm provides a provider-agnostic client for chat-based large language models.
Package mcp connects stdio-based MCP (Model Context Protocol) servers to a ToolBox from the tools package.
Package mcp connects stdio-based MCP (Model Context Protocol) servers to a ToolBox from the tools package.
Package skills gives a model instructions it loads only when it needs them.
Package skills gives a model instructions it loads only when it needs them.
Package tools helps wire model tool calls to Go code.
Package tools helps wire model tool calls to Go code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL