Read Me MCP

自述MCP服务器

GitHub自动分析存储库README.md生成保存MCP服务器。Claude Desktop合作，对话README中所述修改相应参数的值。

机能

1. README自动生成（generate_readme)

• GitHub在动态输入提示中单击URL领取
• 分析存储库信息（语言、星号、分叉、主题、许可证等）
• 获取项目结构、相关性文件和供应商信息
• 全面的README.md自动生成内容

2. GitHub保存机能（save_readme_to_github)

• 已生成README的GitHub直接提交到存储库
• 现有的README.md有更新，没有新建
• 支持自定义提交消息
• 承诺URLSHA返回

技术栈

• Python 3.11
• MCP（模型上下文协议）
• PyGithub
• 码头工人

安装，安装

需要的东西

• Docker&Docker编写
• Claude Desktop（MCP客户机）
• GitHub Personal Access Token（书き込み権限必要）

安装

1. 克隆存储库

git clone https://github.com/kurocafe/ReadME-MCP.git
cd ReadME-MCP

1. GitHub Personal Access Tokenの取得

a. https://github.com/settings/tokens访问

b. "Generate new token" →“Tokens（classic）”を选択

c repo 检查范围（完全访问）

d. 生成并复制标记

1. 设置环境变量

cp .env.example .env
# .envファイルを編集してGitHub APIトークンを設定

.env文件内容：

GITHUB_TOKEN=ghp_your_actual_token_here

1. Docker构建映像

docker-compose build

1. Claude Desktop设定

~/Library/Application Support/Claude/claude_desktop_config.json 添加：

{
  "mcpServers": {
    "readme-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--env-file",
        "/Users/YOUR_USERNAME/GitHub/ReadME-MCP/.env",
        "readme-mcp-readme-mcp",
        "python",
        "-m",
        "readme_mcp.server"
      ]
    }
  }
}

重要: /Users/YOUR_USERNAME/GitHub/ReadME-MCP/.env 中描述的场景，使用以下步骤创建明细表，以便在概念设计中分析体量的体积。

1. Claude Desktopを再起动（Cmd+Q→起动）

使用方法

Claude Desktop在中使用

在您查看完详细信息后，单击Claude Desktop中描述的场景，使用下列步骤创建明细表，以便在概念设计中分析体量的周长：

第1步：README生成

Claude Desktop请求：

https://github.com/username/repository のREADMEを生成して

已生成README中所述修改相应参数的值。

第2步：GitHub保存（可选）

确认内容后GitHub保存为：

生成されたREADMEを https://github.com/username/repository に保存して

用自定义提交消息保存：

生成されたREADMEを https://github.com/username/repository に「READMEを自動生成」というメッセージで保存して

保存成功后提交URL和SHA对话框，您可以在此定义自定义格式。

直接実行（开発用）

MCP如果要直接启动并测试服务器：

docker-compose up

开发模式

自动反映源代码更改：

# ボリュームマウントが設定されているので、コードを編集すると自動反映
docker-compose up

# 別のターミナルでコードを編集
# 変更を反映するにはClaude Desktopを再起動

项目结构

readme-mcp/
├── src/
│   └── readme_mcp/
│       ├── __init__.py
│       ├── server.py           # MCPサーバーのメイン処理
│       ├── github_analyzer.py  # GitHubリポジトリ解析
│       └── readme_generator.py # README生成ロジック
├── tests/                      # テストコード
├── Dockerfile                  # Docker設定
├── docker-compose.yml          # Docker Compose設定
├── requirements.txt            # Python依存パッケージ
└── pyproject.toml             # Pythonプロジェクト設定

故障排除

401错误

GitHub token未正确设置：

1. .env确认文件是否存在
2. GITHUB_TOKEN确认是否正确设置
3. Claude Desktop设置--env-file验证路径是否正确
4. Claude Desktop重新启动

404错误

仓库URL错误：

• 正确格式： https://github.com/owner/repository
• 尾部斜线将自动删除
• .git扩展名也会自动处理

检查调试日志

# 実行中のコンテナのログを確認
docker logs -f $(docker ps --filter "ancestor=readme-mcp-readme-mcp" -q)

# デバッグログのみを表示
docker logs $(docker ps --filter "ancestor=readme-mcp-readme-mcp" -q) 2>&1 | grep DEBUG

技术详细

已实现的功能

• URL透视处理：各种形式的GitHub URL（查询参数、片段、。git扩展名等）
• 存储库分析: PyGithub API对较大场景进行渲染期间已观察到该故障
• README生成：根据项目特性生成适当的节
• GitHub API连携：支持读写
• 错误处理：详细的错误消息和日志输出

对应的从属文件

• package.json （Node.js）
• requirements.txt python
• Cargo.toml （生锈）
• go.mod （去）
• pom.xml （Java/Maven）
• build.gradle （Java/Gradle）
• Gemfile （红宝石）

开発状况

✅ 完成：基本功能已完成实施Claude Desktop中所述修改相应参数的值。

许可证

麻省理工学院