内容
# 代理 README 生成器 MCP
[](https://smithery.ai/server/@Rumblingb/agent-readme-generator-mcp)
[](https://www.npmjs.com/package/agentpay-readme-generator-mcp)
[](https://github.com/Rumblingb/agent-readme-generator-mcp)
[](LICENSE)
[](https://www.python.org/)
[](https://rumblingb.github.io/agent-readme-generator-mcp)
一个 MCP（模型上下文协议）服务器，用于为 GitHub 仓库生成专业的 README 文件。适用于 MCP 兼容的客户端，如 Claude Desktop、Cursor 和 VS Code。
## 功能
- **readme_generate** — 根据仓库名称、描述、功能和工具列表生成完整、格式化的 README
- **readme_add_badge** — 为徽章（Smithery、npm、GitHub 星星、Python、许可证）生成 Markdown
- **readme_validate** — 根据最佳实践（标题、描述、安装、使用、许可证、徽章、目录）检查 README
- **readme_templates** — 列出可用的 README 模板（Python MCP、REST API、HTML 工具、CLI 应用、npm 包）
## 定价
| 等级 | 价格 | 功能 |
|------|-------|----------|
| **免费** | $0 | 每个会话 5 个 README |
| **专业版** | **$9/月** | 无限 README、自定义品牌、所有模板、优先支持 |
[**订阅专业版 →**](https://rumblingb.github.io/agent-readme-generator-mcp)
## 安装
### 选项 1：npm（推荐用于 MCP 客户端）
```bash
npm install -g agentpay-readme-generator-mcp
```
### 选项 2：Smithery
[从 Smithery 安装](https://smithery.ai/server/@Rumblingb/agent-readme-generator-mcp)
### 选项 3：手动
```bash
git clone https://github.com/Rumblingb/agent-readme-generator-mcp.git
cd agent-readme-generator-mcp
pip install -r requirements.txt
python server.py
```
## MCP 配置
### Claude Desktop
添加到您的 `claude_desktop_config.json`：
```json
{
"mcpServers": {
"readme-generator": {
"command": "python",
"args": ["-m", "server"],
"env": {
"PYTHONPATH": "/path/to/agent-readme-generator-mcp"
}
}
}
}
```
### Cursor
添加到 Cursor 的 MCP 配置中。
### VS Code
添加到 VS Code 的 GitHub Copilot 设置中。
## 工具
### `readme_generate`
生成完整的 README 文件。
**参数：**
- `name`（字符串）：仓库名称
- `description`（字符串）：项目描述
- `features`（字符串数组）：功能列表
- `tools`（字符串数组）：工具/命令列表
- `template`（字符串）：模板类型（`python-mcp`、`rest-api`、`html-tool`、`cli-app`、`npm-package`）
- `session_id`（字符串，可选）：用于速率限制的会话标识符
### `readme_add_badge`
为徽章生成 Markdown。
**参数：**
- `type`（字符串）：徽章类型（`smithery`、`npm`、`github-stars`、`python`、`license`）
- `repo`（字符串）：GitHub 仓库（所有者/仓库格式）
- `package`（字符串）：npm 包名称
### `readme_validate`
根据最佳实践检查清单验证 README。
**参数：**
- `content`（字符串）：要验证的完整 README 文本
### `readme_templates`
列出可用的 README 模板及其章节布局。
## 开发
```bash
git clone https://github.com/Rumblingb/agent-readme-generator-mcp.git
cd agent-readme-generator-mcp
pip install -r requirements.txt
python server.py
```
## 测试
```bash
# 测试服务器启动并响应工具/列表
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | python server.py
```
## 部署
该网站通过 GitHub Pages 部署在 [rumblingb.github.io/agent-readme-generator-mcp](https://rumblingb.github.io/agent-readme-generator-mcp)。
## 许可证
MIT
