-
-
Notifications
You must be signed in to change notification settings - Fork 0
Guides
Jonathan D.A. Jewell edited this page Aug 7, 2026
·
2 revisions
Task-oriented pointers. Each links to the in-repo document that owns the topic.
| Task | Where |
|---|---|
| Add BoJ to an MCP client | Getting-Started |
| Scope which tools are exposed |
BOJ_TOOL_SCOPE — see README §Environment |
| Run over HTTP instead of stdio |
BOJ_TRANSPORT=http — see README §Environment |
| Rate-limit or authenticate |
BOJ_RATE_LIMIT, BOJ_HTTP_AUTH — README §Environment |
| Task | Where |
|---|---|
| Fetch the catalogue |
scripts/fetch-cartridges.sh + BOJ_CARTRIDGES_PATH
|
| Author a new cartridge | In the registry, not here — just mint
|
| Understand the ABI contract | Architecture → the five symbols |
Authoring instructions that tell you to create
cartridges/<name>/in this repository are stale. That tree was retired; new cartridges are minted in the registry.
| Task | Where |
|---|---|
| Deploy / run as a service | MAINTAINER quickstart |
| Container image | Containerfile |
| Federation / seed nodes | docs/FEDERATION.adoc |
| Task | Where |
|---|---|
| Conventions and gates | docs/AI-CONVENTIONS.adoc |
| Why required checks are shaped that way | CI-and-Required-Checks |
| Report a vulnerability | SECURITY.md |
| Pick up known debt | DEBT.md |