README Insight MCP
Provides tools to summarize README files from local paths or public Git repositories into structured JSON summaries. It enables users to quickly extract key facts and project overviews from documentation through automated tool calls.
README
README Insight MCP
Small MCP server that summarizes README files from either a local path or a public Git repository. It exposes:
- Tools:
readme_summaryfor local paths andreadme_from_gitfor remote repos - Resources:
readme://local/currentfor accessing the current directory's README - Prompts:
analyze_readmefor analyzing a README's completeness
What it shows
- How to define MCP tools, resources, and prompts
- How to summarize README content from local files or Git URLs
- A clear, demo-friendly use case
Setup
git clone /home/naeemgtng/projects/example-mcp
cd example-mcp
npm install
Run
npm run dev
Example Claude MCP setup
claude mcp add readme-insight -- npx tsx /home/naeemgtng/projects/example-mcp/src/server.ts
Example tool calls
{
"name": "readme_summary",
"arguments": {
"path": "."
}
}
{
"name": "readme_from_git",
"arguments": {
"repo_url": "https://github.com/user/repo"
}
}
Example output
{
"summary": "First paragraph of the README...",
"key_facts": [
"Install",
"Run",
"Example tool call"
]
}
Resources
The server exposes one resource:
| URI | Description |
|---|---|
readme://local/current |
Returns the README from the current working directory |
Prompts
The server exposes one prompt:
| Name | Description | Arguments |
|---|---|---|
analyze_readme |
Analyze a README for completeness | repo_url (required): Git repository URL |
Example prompt call:
{
"name": "analyze_readme_prompt",
"arguments": {
"repo_url": "https://github.com/user/repo"
}
}
Read about it here
Recommended Servers
playwright-mcp
A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.
Magic Component Platform (MCP)
An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.
Audiense Insights MCP Server
Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.
VeyraX MCP
Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.
Kagi MCP Server
An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.
graphlit-mcp-server
The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.
Qdrant Server
This repository is an example of how to create a MCP server for Qdrant, a vector search engine.
Neon Database
MCP server for interacting with Neon Management API and databases
Exa Search
A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.
E2B
Using MCP to run code via e2b.