README Insight MCP

Small MCP server that summarizes README files from either a local path or a public Git repository. It exposes two tools: readme_summary for local paths and readme_from_git for remote repos, both returning a JSON summary.

What it shows

How to define MCP tools and input schemas
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"
  ]
}

example-mcp