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
| Topic | Covers |
|---|---|
usage | Every global option, how a run starts, and the files read at startup |
serve | Running Woodentable as an MCP server |
mcp | Adding other servers, signing in, and calling them |
mounts | How mounts are written, and the rules they follow |
resources | Saving mounts, tools and servers as a profile |
ai | Running a local model |
runtime | Saving a model setup as a profile |
pkg | Backends, and updating Woodentable |
catalog | The catalog of files, from a script |
session | Sessions, from a script |
agent | Agent definitions: a saved role, profiles and confirmation policy |
tracing | Sending traces to your own monitoring service |
stats | What the usage counts hold, and how to turn them off |
doc | Showing a Markdown file at the terminal |
Writing tools
Start at author-index. With -dev, your agent reads these in its session too.
| Topic | Covers |
|---|---|
mcp-tools | Publishing a procedure as a tool |
mcp-resources | Publishing data a client reads by address |
mcp-prompts | Publishing a prompt a user picks |
content | Returning images and structured data |
paths | Catalog paths and real paths, for running other programs |
reload | Loading a tool you've just written |
safe-interp | Which 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.
| Topic | Covers |
|---|---|
sandbox | What a script may do, and quoting in Tcl |
files | Reading, writing and editing files |
search | Searching files, and tagging them |
results | Returning an image, a sound or structured data |
upstream | Calling other servers, and reading their answers |
recipes | Whole tasks, done end to end |
woodentable help agent-index
woodentable help author-index