Skip to main content
Glama

README Insight MCP

Small MCP server that summarizes README files from either a local path or a public Git repository. It exposes:

  • Tools: readme_summary for local paths and readme_from_git for remote repos

  • Resources: readme://local/current for accessing the current directory's README

  • Prompts: analyze_readme for 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

Install Server
A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

Latest Blog Posts

MCP directory API

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

curl -X GET 'https://glama.ai/api/mcp/v1/servers/naeem-gitonga/example-mcp'

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