Woodentable

The built-in guides

Woodentable carries its full reference with it, always matching the version you run. These pages get you started; the guides have every option and detail.

Reading them

woodentable help
woodentable help topics
woodentable help serve

help explains the command line, help topics lists the guides, and help with a topic opens that guide.

The command line

TopicCovers
usageEvery global option, how a run starts, and the files read at startup
serveRunning Woodentable as an MCP server
mcpAdding other servers, signing in, and calling them
mountsHow mounts are written, and the rules they follow
resourcesSaving mounts, tools and servers as a profile
aiRunning a local model
runtimeSaving a model setup as a profile
pkgBackends, and updating Woodentable
catalogThe catalog of files, from a script
sessionSessions, from a script
agentAgent definitions: a saved role, profiles and confirmation policy
tracingSending traces to your own monitoring service
statsWhat the usage counts hold, and how to turn them off
docShowing a Markdown file at the terminal

Writing tools

Start at author-index. With -dev, your agent reads these in its session too.

TopicCovers
mcp-toolsPublishing a procedure as a tool
mcp-resourcesPublishing data a client reads by address
mcp-promptsPublishing a prompt a user picks
contentReturning images and structured data
pathsCatalog paths and real paths, for running other programs
reloadLoading a tool you've just written
safe-interpWhich interpreter your code runs in

Working in the sandbox

These are written for your agent, which reads them inside its session under /usr/share/help, starting at /usr/share/help/agent/index.md. You can read them at the console too, starting at agent-index.

TopicCovers
sandboxWhat a script may do, and quoting in Tcl
filesReading, writing and editing files
searchSearching files, and tagging them
resultsReturning an image, a sound or structured data
upstreamCalling other servers, and reading their answers
recipesWhole tasks, done end to end
woodentable help agent-index
woodentable help author-index