Interface ToolManifestEntry

Machine-readable tool registry. Single source of truth for:

which tools exist
their gating (always-on / opt-in via which flag)
their description
their input schema reference

Consumers:

tool-registry.ts iterates this to call server.registerTool()
tests/docs-consistency.test.ts iterates this to verify api.md coverage
future: auto-generate docs/api.md table from this

Introduced in v3.6.0-rc.2 alongside the src/index.ts → domain-module split. Populated by hand from the existing registerReadTools / registerWriteTools / registerFtsTools call sites. The summary field is a 1-line distillation of the registerTool() description argument — the full description stays at the registration site so MCP clients still see verbatim what they did pre-refactor. Count math invariant (enforced by docs-consistency.test.ts): 44 total = 33 always-on read

1 fts (opt-in via --persistent-index) + 3 diagnostic (opt-in via --diagnostic-search-tools) + 7 write (opt-in via --enable-write).

interface ToolManifestEntry {
    gating:
        | "--enable-write"
        | "--persistent-index"
        | "--diagnostic-search-tools"
        | "always"
        | "--persistent-index + --diagnostic-search-tools";
    kind: "read"
    | "fts"
    | "write"
    | "diagnostic";
    name: string;
    summary: string;
}

Index

Properties

gating kind name summary

Properties

gating

Human-readable gating clause shown in docs.

kind

kind: "read" | "fts" | "write" | "diagnostic"

Registration kind — drives WHICH register*Tools fn picks it up.

name

name: string

Tool name as registered (e.g., "obsidian_search").

summary

summary: string

One-line summary (~60 chars). Detailed description lives in the registerTool() call's description field.

Interface ToolManifestEntry

Index

Properties

Properties

gating

kind

name

summary

Settings

On This Page