Schema | github-readme-mcp

github-readme-mcp

Describes the environment variables required to run the server.

Name	Required	Description	Default
No arguments

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

This server publishes no instructions, or was last inspected before Glama recorded them.

Features and capabilities supported by this server

Protocol revision2025-11-25

Capability	Details
`tools`	{}

Functions exposed to the LLM to take actions

Name	Description
analyze_readme	Analyze README markdown from pasted content, a local file path, a GitHub repo URL, or a raw file URL. Returns scores, detected/missing sections, issues, quick wins, and a deterministic intro rewrite.
suggest_readme_improvementsC	Same inputs as analyze_readme. Returns grouped recommendations (mustFix / shouldImprove / niceToHave) with rationale and optional example text.
rewrite_intro	Rewrite README introduction variants deterministically; optionally refined via OPENAI_API_KEY.
generate_improved_readme	Produce an improved README draft: fills common gaps with scaffolds, optional badges and contributing section. Deterministic baseline; optional OpenAI polish.
compare_before_afterB	Compare two README markdown strings and summarize improvements vs remaining gaps.

Interactive templates invoked by user choice

Name	Description
No prompts

Contextual data attached and managed by the client

Name	Description
No resources

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/QinyangTan/GitHub-README-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server