Claude Fable 5
04e21a0aac
All checks were successful
CD / Build and push images (push) Successful in 3m50s
CI / Lint, typecheck, test (push) Successful in 4m2s
CI / Build container images (push) Has been skipped
CD / Deploy to Test (push) Successful in 11s
CD / Smoke tests against Test (push) Successful in 1m14s
CD / Promote to Int (push) Successful in 13s
CI / Auth e2e pack (push) Successful in 5m37s
CI / Import/export fidelity gate (push) Successful in 47s
AI clients talk to the instance directly at /api/mcp — under the /api/ path (deviation from the issue's literal /mcp) so every existing reverse proxy already routes it; no deployment changes anywhere. - Transport: official @modelcontextprotocol/sdk server, STATELESS — each POST builds a fresh server+transport pair, no session store, replicas stay trivial; GET/DELETE answer 405. Auth per PAT bearer (#104 tokens), per-token rate limit (429 + Retry-After). - Own switches, independent of REST: instance mcp.enabled (admin settings, default off; off = 404, feature invisible) + pond setting mcpEnabled (pond-settings toggle, default off) — pinned independent in both directions by tests. - Tools (thin wrappers over the #104 services, same permission gates, audit-logged writes): list_ponds, list_pages, read_page, search, create_page, update_page (replace semantics through the collab-owned restore path — open editors converge), add_comment, list_labels, set_page_labels (exact replace), export_pond (link to the REST ZIP). Tool errors carry the api error codes; results carry stable slugs/ids. MCP resources stay the documented stage-2 stretch goal. - Deliberately on the SDK's low-level Server API with a hand-written tool table (mcp-tools.ts): the typed registerTool generics drove tsc out of memory in a program this size; manual Zod validation keeps the wire behavior explicit. - PublicApiService exposure filtering parameterized ('api' | 'mcp', shared pondFeatureEnabled helper) — one implementation, two switches. - Docs: "Connect Claude Code / MCP clients" section in public-api.md (claude mcp add one-liner + mcp-remote bridge for stdio clients). Verification: 8-test e2e pack driving the real MCP SDK client over Streamable HTTP against a listening api (initialize + tools/list, switch independence in both directions, anonymous/garbage 401, opt-in 404 semantics, page roundtrip incl. restore-NOTIFY, labels/comments, read scope blocked from writes with scope_required); live check through the web proxy against the seeded stack (tools list, create, read, update, search — LIVE CHECK PASSED); full api suite 61/61 files green. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EwZ4jR4KFAPvpjWevfUGX1
56 lines
2.5 KiB
JSON
56 lines
2.5 KiB
JSON
{
|
|
"section": {
|
|
"title": "API tokens",
|
|
"intro": "Personal access tokens let scripts and integrations use the public API as you. A token has your permissions, narrowed by its scope and an optional pond restriction.",
|
|
"instanceDisabled": "The public API is currently disabled on this instance — tokens can be created but will not work until a Site Admin enables it.",
|
|
"empty": "No API tokens yet."
|
|
},
|
|
"fields": {
|
|
"name": "Name",
|
|
"scope": "Scope",
|
|
"scopeRead": "Read only",
|
|
"scopeWrite": "Read and write",
|
|
"expiresAt": "Expires (optional)",
|
|
"ponds": "Restrict to ponds (optional)",
|
|
"pondsHint": "No selection = every pond you can access (that has the API enabled)."
|
|
},
|
|
"list": {
|
|
"created": "Created",
|
|
"lastUsed": "Last used",
|
|
"never": "never",
|
|
"expires": "Expires",
|
|
"status": "Status",
|
|
"active": "Active",
|
|
"revoked": "Revoked",
|
|
"expired": "Expired",
|
|
"allPonds": "all ponds",
|
|
"revoke": "Revoke",
|
|
"revokeConfirm": "Revoke this token? Clients using it stop working immediately."
|
|
},
|
|
"create": {
|
|
"button": "Create token",
|
|
"pending": "Creating…",
|
|
"createdTitle": "Token created",
|
|
"createdHint": "Copy it now — it is shown only this once.",
|
|
"copy": "Copy",
|
|
"copied": "Copied."
|
|
},
|
|
"pond": {
|
|
"title": "Public API",
|
|
"label": "Expose this pond through the public API",
|
|
"hint": "Off by default. When enabled, users can reach this pond with their API tokens — with exactly the permissions they have here anyway. The instance-wide API switch must also be on.",
|
|
"saved": "Saved.",
|
|
"mcpLabel": "Expose this pond to AI assistants (MCP)",
|
|
"mcpHint": "Off by default and independent of the REST toggle. When enabled, MCP clients such as Claude Code can reach this pond with an API token — again with exactly the user's permissions. The instance-wide MCP switch must also be on."
|
|
},
|
|
"admin": {
|
|
"title": "Public API",
|
|
"label": "Enable the public REST API",
|
|
"hint": "Master switch (default off). Users then create personal access tokens in their settings; each pond additionally opts in via its pond settings. Documentation: /api/public/v1/openapi.json",
|
|
"save": "Save",
|
|
"saved": "Saved.",
|
|
"mcpLabel": "Enable the built-in MCP endpoint",
|
|
"mcpHint": "Master switch (default off), independent of the REST API. MCP clients connect to /api/mcp with an API token; each pond additionally opts in via its pond settings. See docs/self-hosting/public-api.md."
|
|
}
|
|
}
|