Commit 0acfb06
docs: auto-generate tool documentation from MCP server metadata (#394)
Add a script that introspects the server's registered tools at runtime
and generates per-category markdown pages under docs/tools/, ensuring
documentation exactly matches the JSON schema advertised by the server.
- Add scripts/generate_tool_docs.py to generate docs from tool metadata
- Generate one page per category (system-info, services, logs, etc.)
- Include parameter details with types, defaults, and constraints
- Include structured return types with nested field expansion
- Filter out internal tools (hidden_from_model) and the host parameter
- Replace hand-written docs/tools.md placeholder with generated pages
- Add docs/tools/ to .gitignore (generated at build time, not committed)
- Document the generation step in contributing.md
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>1 parent b9473ed commit 0acfb06
6 files changed
Lines changed: 445 additions & 61 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
| 42 | + | |
42 | 43 | | |
43 | 44 | | |
44 | 45 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
54 | | - | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
238 | 238 | | |
239 | 239 | | |
240 | 240 | | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
241 | 261 | | |
242 | 262 | | |
243 | 263 | | |
| |||
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
69 | | - | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
70 | 77 | | |
71 | 78 | | |
72 | 79 | | |
| |||
0 commit comments