Skip to content

feat: auto-generate README tool table from tool definitions#30

Merged
siddhant3030 merged 9 commits into
mainfrom
feat/readme-tool-table
Jun 3, 2026
Merged

feat: auto-generate README tool table from tool definitions#30
siddhant3030 merged 9 commits into
mainfrom
feat/readme-tool-table

Conversation

@siddhant3030

Copy link
Copy Markdown
Collaborator

Summary

  • Adds scripts/generate_tool_table.py which imports the FastMCP app and calls app.list_tools() to extract tool names and docstrings at runtime
  • Updates README.md with a per-tool reference table (62 tools) grouped by category (Organization, Warehouse, Pipelines, Sources, Connections, Dashboards, Charts, Reports, Transforms, Notifications, Documentation), replacing the hand-maintained summary table
  • Uses sentinel comments (<!-- TOOLS_TABLE_START --> / <!-- TOOLS_TABLE_END -->) so the table can be regenerated without manual editing
  • Run python scripts/generate_tool_table.py (or uv run python scripts/generate_tool_table.py) after adding new tools to keep docs in sync

Test plan

  • Script runs without error: uv run python scripts/generate_tool_table.py
  • README.md contains a table with all 62 tools grouped by category
  • Re-running the script produces identical output (idempotent — verified by running 3×)
  • After adding a new tool to any module, re-running the script picks it up automatically

Closes #9

🤖 Generated with Claude Code

@siddhant3030 siddhant3030 merged commit 6509e86 into main Jun 3, 2026
@siddhant3030 siddhant3030 deleted the feat/readme-tool-table branch June 3, 2026 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Auto-generate README tool table from tool definitions

1 participant