@zsc-glitch/doc-generator-mcp
v0.1.0-alpha.1
Published
MCP Server for Documentation Generation - Auto-generate README, API docs, changelog for hermes-agent, Claude Code
Maintainers
Readme
Doc Generator MCP
MCP Server for Documentation Generation - Auto-generate README, API docs, changelog for hermes-agent, Claude Code
安装
npm install @zsc-glitch/doc-generator-mcpMCP Tools
1. doc_generate_readme
自动生成 README.md:
{
"tool": "doc_generate_readme",
"arguments": {
"projectName": "my-mcp-tool",
"description": "A MCP tool for...",
"version": "0.1.0",
"author": "小影",
"tools": ["tool1", "tool2"]
}
}生成的 README 包含:
- npm badges
- 安装说明
- MCP 工具表格
- 使用示例
2. doc_generate_api_doc
生成 API 文档:
{
"tool": "doc_generate_api_doc",
"arguments": {
"moduleName": "Core",
"functions": [
{
"name": "saveData",
"description": "保存数据",
"params": [
{ "name": "data", "type": "object", "description": "数据对象" }
],
"returns": { "type": "string", "description": "保存的ID" }
}
]
}
}3. doc_generate_changelog
生成 CHANGELOG.md:
{
"tool": "doc_generate_changelog",
"arguments": {
"versions": [
{
"version": "0.1.0",
"date": "2026-04-14",
"changes": ["初始发布", "基础功能"]
},
{
"version": "0.2.0",
"date": "2026-04-15",
"changes": ["新增功能 X", "修复 bug Y"]
}
]
}
}4. doc_generate_doc_suite
生成完整文档套件:
{
"tool": "doc_generate_doc_suite",
"arguments": {
"projectPath": "/path/to/project"
}
}自动生成:
- README.md
- CHANGELOG.md
- CONTRIBUTING.md
与 hermes-agent 配合
{
"mcpServers": {
"doc-generator": {
"command": "node",
"args": ["path/to/doc-generator-mcp/dist/index.js"]
}
}
}Made with ❤️ by 小影
