Skip to main content
All four surfaces use the same hosted wiki. Choose based on where your code runs and whether it needs local files or write access.
The CLI, Python SDK, REST API, and MCP all connect to one hosted Almanac wiki; MCP is read-only.

Compare the surfaces

SurfaceBest forAccessAuthWiki identifierFile upload
CLIPeople, coding agents, shell automationRead + writeBrowser session or API keyHandleFiles and recursive folders
Python SDKPython services and scriptsRead + writeReused CLI session or API keyHandleIndividual file paths
REST APIServices in any languageKey permissionsAPI keyResource IDsPrepare, upload to signed storage, complete
MCPRemote AI clients that need contextRead-onlyBrowser-approved OAuthExplicit handle on every callNone

A practical default

  • Start with the CLI when a person or agent can use a terminal. It is the only surface that recursively discovers local folders.
  • Use the Python SDK when Python code should work with validated models and a resolved wiki handle.
  • Use the REST API for non-Python services or direct control over /v1.
  • Use MCP when an AI client only needs to search and read existing knowledge.

Use the CLI

Work interactively or automate with JSON and stable exit codes.

Use the Python SDK

Search, upload, and follow jobs from Python.

Call the REST API

Authenticate, discover IDs, and make a direct request.

Connect through MCP

Give an AI client read-only wiki context.