Skip to content

Generate README.md tools section from schema #223

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

Jump to bottom
Open
williammartin opened this issue Apr 11, 2025 · 1 comment
Open

Generate README.md tools section from schema #223

williammartin opened this issue Apr 11, 2025 · 1 comment
Assignees
@williammartin

Comments

@williammartin
Copy link
Collaborator

williammartin commented Apr 11, 2025 •
edited
Loading

Description

It's very easy for the README Tools section to get out of date with the real schema.

#221
#205 (review)

Suggestion

Include a script in the repository that uses the MCP Server schema to produce the README tools section contents. I'm hoping we can get access to this somehow without starting the server and sending an list tools request. Maybe this could go into upstream mcp-go as a utility.

In CI, generate this file and compare to the contents of the tools section in the PR, if there is a diff then error with guidance on how to run the script.
@williammartin williammartin self-assigned this Apr 11, 2025
@SamMorrowDrums
Copy link
Collaborator

Maybe this could go into upstream mcp-go as a utility.

That would be phenomenal generally, but would be amazing for us regardless.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@williammartin williammartin

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@williammartin @SamMorrowDrums