Skip to content

tool-surface.md

Latest commit

 

History

History
49 lines (38 loc) · 1.69 KB

tool-surface.md

File metadata and controls

49 lines (38 loc) · 1.69 KB

Tool surface

The server boots in a compact workflow: the MCP client sees a small operator-style surface while the full Appwrite catalog stays internal and is searched at runtime.

flowchart LR
    M[Model] -->|sees| E

    subgraph E[Exposed surface — up to 4 tools]
        C[appwrite_get_context]
        ST[appwrite_search_tools]
        CT[appwrite_call_tool]
        SD[appwrite_search_docs *]
    end

    ST -.searches.-> CAT
    CT -.invokes.-> CAT

    subgraph CAT[Internal catalog — 25 services]
        direction LR
        K[account · databases · functions<br/>storage · teams · users · …]
    end

    CT -->|large output| R[(MCP resource<br/>preview + URI)]
Loading

* appwrite_search_docs is registered only when the docs index and OPENAI_API_KEY are present — see Documentation search.

Exposed tools

Tool What it does
appwrite_get_context Workspace summary. API key → project + readable service totals/samples. OAuth → also account, organization, discovered projects.
appwrite_search_tools Searches the internal catalog at runtime.
appwrite_call_tool Invokes a catalog tool. Mutating calls require confirm_write=true.
appwrite_search_docs Semantic search over Appwrite docs (conditional — see above).

Behavior

  • Large outputs are stored as an MCP resource and returned as preview text plus a resource URI.
  • Writes through hidden mutating tools require confirm_write=true.
  • Access is gated per-route by the scopes the OAuth token was granted, not by the catalog.
  • Registration is automatic — every service the installed SDK ships becomes a catalog entry.