Skip to content

docs(mcp): add generated MCP tool reference #1385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
phernandez wants to merge 4 commits into from
Closed

docs(mcp): add generated MCP tool reference #1385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de39423
docs(mcp): add tool reference generator and generated artifact
FBISiri Aug 30, 2026
a8642d2
docs(mcp): address review on the generated tool reference
phernandez Aug 30, 2026
d41dadc
test(mcp): fail when the committed tool reference is stale
phernandez Aug 30, 2026
72e57b0
fix(mcp): keep the phrase-and-keyword search example valid Python
phernandez Aug 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,8 @@ agents can pick the right one without trial-and-error:
All MCP tools default to text output; pass `output_format="json"` for
structured responses. Full tool reference in the
[docs](https://docs.basicmemory.com/?utm_source=github&utm_medium=referral&utm_campaign=readme).
A per-tool parameter reference generated from the source lives in
[docs/mcp-tools.md](docs/mcp-tools.md).

## CLI essentials

Expand Down
626 changes: 626 additions & 0 deletions docs/mcp-tools.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,6 +510,10 @@ clean:
format:
uv run ruff format .

# Regenerate docs/mcp-tools.md from the MCP tool sources
tool-docs:
uv run python scripts/generate_tool_docs.py

# Run MCP inspector tool
run-inspector:
npx @modelcontextprotocol/inspector
Expand Down
Loading
Loading