github-readme-mcp
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Instructions
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.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {} |
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. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 2 tools
The two tools have distinct inputs and outputs (compare vs. suggest), but the reference to a non-existent 'analyze_readme' tool in the suggest tool's description creates ambiguity about the intended workflow.
Both tools follow a consistent verb_noun pattern with snake_case, but the missing 'analyze_readme' tool referenced in the description is a minor inconsistency.
With only 2 tools, the server feels incomplete for its stated purpose of README analysis. A typical set would include at least 3-5 tools for a well-scoped domain.
The server lacks a basic 'analyze_readme' tool that is referenced in the suggest tool's description, and the surface only covers comparison and suggestion, missing standalone analysis and likely other operations.