MCP Documentacion

SmartDocMcp

用于智能生成软件项目技术文档的MCP服务器（模型上下文协议）。

📋 描述

SmartDocMCP是一种服务器，它实现了MCP协议，以自动生成软件开发项目中的技术文档。服务器分析项目的源代码并生成结构化上下文，以创建拼写正确的不同类型的中性西班牙语技术文档。

✨ 特点

• 生成多种类型的文档：

- README.md -一般项目文件 - API.md -端点文件和API合同 - ARCHITECTURE.md 软件体系结构文件 - SRS.md -软件需求规范 - CHANGELOG.md -更改和版本注册

• 智能代码分析：

- 根据请求的文档类型识别相关文件 - 过滤不必要的目录（节点模块、bin、obj等） - 从项目中提取上下文信息

• MCP集成：

- 与Claude Desktop等MCP客户兼容 - 通过JSON-RPC 2.0通信 - 对口音和特殊字符的完整UTF-8支持

🔧 要求

• .NET 9.0 SDK o上级
• 操作系统：Windows、Linux或MacOS
• 兼容的MCP客户端（可选，用于与AI集成）

📦 安装

1.克隆存储库

git clone 
cd SmartDocMcp

2.恢复依赖关系

dotnet restore

3.编写项目

dotnet build

4.公共（运营）

要创建独立的可执行文件：

dotnet publish -c Release -r win-x64 --self-contained

🚀 使用

直接执行

dotnet run

服务器将启动并通过stdin/stdout听取JSON-RPC请求。

克劳德桌面上的设置

在Claude Desktop配置文件中添加以下设置：

窗户： %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "SmartDocMcp": {
      "command": "dotnet",
      "args": ["run", "--project", "C:\\ruta\\a\\SmartDocMcp\\SmartDocMcp.csproj"]
    }
  }
}

你是唯一的 dotnet publish:

{
  "mcpServers": {
    "SmartDocMcp": {
      "command": "C:\\ruta\\a\\SmartDocMcp\\bin\\Release\\net9.0\\win-x64\\SmartDocMcp.exe"
    }
  }
}

🛠️ 可用的工具

服务器公开了以下MCP工具：

doc_readme

生成上下文以创建自述.md文件

参数：

• projectRoot （字符串）：要记录的项目的根路径

doc_api

通用上下文辅助文档API（控制器、路由、DTO、端点）

参数：

• projectRoot （字符串）：项目根路径

doc_sad

为软件架构文档（architecture.md）生成上下文

参数：

• projectRoot （字符串）：项目根路径

doc_srs

为软件需求规范生成上下文

参数：

• projectRoot （字符串）：项目根路径

doc_changelog

为更改日志（changelog.md）生成上下文

参数：

• projectRoot （字符串）：项目根路径

save_document

将生成的内容保存在文件夹内的.md文件中 Doc

参数：

• fileName （字符串）：文件名（例如：“readme.md”）
• content （字符串）：文档内容
• projectRoot （字符串）：项目根路径

📁 项目结构

SmartDocMcp/
├── Program.cs              # Punto de entrada y servidor MCP
├── DocService.cs           # Lógica de análisis de código
├── McpModels.cs           # Modelos para MCP (Request/Response)
├── SmartDocMcp.csproj     # Configuración del proyecto
├── SmartDocMcp.sln        # Solución de Visual Studio
└── README.md              # Este archivo

🔍 它是如何工作的

1. 服务器通过STDIN接收JSON-RPC 2.0请求
2. 使用工具（Tools）功能实现MCP协议
3. 当调用工具时 doc_*:

- 分析项目寻找相关文件 - 过滤不必要的文件夹（节点模块、bin等） - 提取关键文件的内容 - 为LLM生成文档生成结构化上下文

1. 工具 save_document 将结果保存到文件夹 Doc/

📝 与Claude一起使用的示例

Usuario: "Genera la documentación API para mi proyecto en C:\MiProyecto"

Claude invoca: doc_api con projectRoot: "C:\MiProyecto"
→ SmartDocMcp analiza controllers, routes, DTOs
→ Retorna contexto estructurado

Claude genera la documentación basándose en el contexto

Claude invoca: save_document
→ SmartDocMcp guarda en C:\MiProyecto\Doc\API.md

🎯 搜索模式

服务器根据文档类型使用特定的模式：

• API：控制器、路由、dto、端点、处理程序、swaggle
• 悲伤：模块、架构、基础设施、核心、配置、组件
• 软件需求规格说明书：服务、逻辑、领域、特征、需求、实体
• 自述文件：package.json、main、index、app、csproj、pom.xml
• 更新日志：提交、版本、历史记录、发布

🐛 调试

错误和诊断信息发送到STDERR：

dotnet run 2> errores.log

🤝 贡献

欢迎捐款。请：

1. 梁叉项目
2. 为您的功能创建分支(git checkout -b feature/NuevaCaracteristica)
3. 提交您的更改(git commit -am 'Agrega nueva característica')
4. 推拉拉马(git push origin feature/NuevaCaracteristica)
5. 打开拉动请求

📄 许可证

这个项目是在麻省理工学院的许可下进行的。查询文件 LICENSE 更多细节。

📧 接触

对于问题、建议或错误报告，请在存储库中打开一个问题。

______________________________________________________________________

版本： 1.1.0\ MCP 协议 ： 2024-11-05\ 框架： .NET 9.0