A
licenseNot graded
qualityD
maintenanceEnables AI models to seamlessly access and query local markdown technical documentation files, providing automatic documentation context without explicit prompting.
10
5
ISC
@mcpx-digital/readme-score
Provides tools for scoring local Markdown README files, suggesting improvements, and checking relative link existence.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@@mcpx-digital/readme-scorescore ./README.md and suggest improvements"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
@mcpx-digital/readme-score
MCP server that scores README quality and suggests improvements.
Honest, heuristic scoring for install/usage/license/badges/structure plus relative link checks. Local markdown files only.
Scoring rubric (100 points)
Category | Max | What we look for |
Title | 5 | Top-level |
Description | 10 | Short prose intro |
Install | 20 | Install heading + package-manager / clone commands |
Usage | 20 | Usage/examples heading + fenced code |
License | 10 | License section or clear license mention |
Badges | 10 | Status/shield badges |
Contributing | 5 | Contributing section or link |
Relative links | 15 | Relative paths resolve on disk |
Structure | 5 | Enough markdown headings |
Grades: A≥90, B≥80, C≥70, D≥60, else F.
Heuristic for documentation completeness — not code quality, security, or SEO.
Related MCP server: MCP Docs Server
Install
npx -y @mcpx-digital/readme-scoreCursor mcp.json example
{
"mcpServers": {
"readme-score": {
"command": "npx",
"args": ["-y", "@mcpx-digital/readme-score"]
}
}
}Local clone:
{
"mcpServers": {
"readme-score": {
"command": "node",
"args": ["/absolute/path/to/readme-score-mcp/index.js"]
}
}
}Tools
Tool | What it does |
| Full 0–100 score with category breakdown |
| Concrete fix list |
| Relative link existence only |
Example prompts
“Score
./README.md”“Suggest README improvements for this repo”
“Which relative links in the README are broken?”
Development
git clone https://github.com/TheoryofShadows/readme-score-mcp.git
cd readme-score-mcp
npm install
npm testLicense
MIT
This server cannot be deployed
Maintenance
ActivityMaintained
ResponsivenessNo issues
Related MCP Connectors
Lint a SKILL.md for frontmatter, structure, secrets and size. All 6 tools free.
Scan any URL for on-page, technical & content SEO; 0-100 score with copy-paste fixes.
Score any URL against a real design contract — 42 checks, A-F grade, token + motion validation.
Scan a web page for accessibility, security, privacy, quality and SEO issues, with fixes.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceProvides direct access to local documentation files through simple search and overview tools, enabling LLMs to query project-specific markdown documentation without requiring vector databases or RAG pipelines.MIT
- AlicenseNot gradedqualityDmaintenanceScans codebases for TODOs, FIXMEs, code complexity, file stats, and dependencies, generating a health report with a letter grade. Zero configuration required.29MIT
- AlicenseNot gradedqualityDmaintenanceGenerates comprehensive documentation (architecture overview, dependency graph, API surface, and README) for any codebase locally without external APIs.51MIT