🚀 文档
docs-mcp 是一款用于管理和控制文档的 Model Context Protocol (MCP) 服务器，支持文档存储管理、版本控制及功能扩展，能有效提升文档管理效率。
🚀 快速开始
若要使用 docs-mcp，请参考 INSTALL.md 进行安装。
✨ 主要特性
- 文档存储与管理
- 文档采用层次结构组织，支持 Markdown、JSON 等多种格式。
- 可通过 MCP 协议进行远程文档交互。
- 版本控制
- 每个文档都有唯一的版本号和变更历史。
- 支持基于语义化的版本控制系统。
- 扩展性
- 提供丰富的插件接口，方便进行自定义功能扩展。
- 支持与 CI/CD、IDE 等多种工具和服务集成。
📦 安装指南
请参考 INSTALL.md 完成安装。
💻 使用示例
基础用法
以下是一个简单的使用示例：
# 启动 docs-mcp 服务器
node dist/server.js --port 3000
# 使用文档管理功能
curl -X POST http://localhost:3000/docs/create \
-H "Content-Type: application/json" \
-d '{"title": "我的第一个文档", "content": "这是我的第一个文档内容"}'
# 查看文档列表
curl http://localhost:3000/docs/list
# 获取特定文档
curl http://localhost:3000/docs/[doc_id]
# 更新文档
curl -X PUT http://localhost:3000/docs/[doc_id] \
-H "Content-Type: application/json" \
-d '{"title": "更新后的标题", "content": "这是更新后的内容"}'
# 删除文档
curl -X DELETE http://localhost:3000/docs/[doc_id]
高级用法
详细命令行选项
以下是 docs-mcp 可用的完整命令行选项：
- 启动服务器
node dist/server.js [--port <端口>] [--env <环境>]
--port：指定服务器监听的端口，默认为 3000。--env：指定运行环境（如 development、production 等），默认为 development。- 文档管理命令
npm run docs-mcp <command> [-- ]
命令:
create 创建新文档
list 列出所有文档
get 获取特定文档
update 更新现有文档
delete 删除文档
文档版本控制
docs-mcp 支持基于语义化的版本控制系统。每次文档更新时，都会自动生成新的版本号，并记录变更历史。
扩展与插件
docs-mcp 提供了丰富的插件接口，允许开发者根据需要扩展功能。例如：
- 日志插件
const { Logger } = require('@modelcontextprotocol/mcp-core').Logger;
module.exports = {
logger: new Logger({
level: 'debug',
handlers: [
// 添加自定义日志处理器
],
}),
};
- 认证插件
const { Auth } = require('@modelcontextprotocol/mcp-core').Auth;
module.exports = {
auth: new Auth({
provider: 'custom',
// 配置自定义认证提供程序
}),
};
示例项目
如需查看更多示例，请访问 DOCS-MCP 示例。
📚 详细文档
代码结构概述
docs-mcp/
├── src/ # 源代码目录
│ ├── server.js # 主服务器文件
│ ├── commands/ # 命令行处理模块
│ └── plugins/ # 插件系统实现
├── dist/ # 编译输出目录
├── package.json # 项目依赖和配置
└── .env.example # 环境变量示例文件
快速开始开发
# 克隆仓库
git clone https://github.com/modelcontextprotocol/docs-mcp.git
cd docs-mcp
# 安装依赖
npm install
# 启动开发服务器
npm run dev
# 编译项目
npm run build
贡献指南
如需为 docs-mcp 做贡献，请参考 CONTRIBUTING.md。
🔧 技术细节
本项目采用了基于语义化的版本控制系统，每次文档更新时，都会自动生成新的版本号，并记录变更历史。同时，项目提供了丰富的插件接口，支持自定义功能扩展和与多种工具和服务集成。
📄 许可证
文档中未提及相关许可证信息。
⚠️ 重要提示
本项目为实验性质，尚未完全稳定，使用前请仔细阅读相关文档并做好数据备份。