docs-mcp

🚀 文档 - 使用 MCP 协议运行的文档服务器

本项目是一个使用 MCP 协议运行的文档服务器，能帮助用户轻松搭建和管理文档服务，支持多种配置方式和功能，满足不同场景下的文档管理需求。

🚀 快速开始

通过以下命令安装并运行文档服务器：

npm install -g mcp-server && mcp-server run docs-config.json

配置文件 docs-config.json 示例

{
  "dataDir": "./data",
  "port": 3000,
  "serverType": "document"
}

✨ 主要特性

数据目录

• dataDir：指定存储文档内容的目录路径。
• globPatterns：配置用于搜索文件的 glob 模式，例如 ["**/*.md", "**/*.txt"]。

服务配置

• port：设置服务器运行的端口号，默认为 3000。
• serverType：定义服务器类型，可选值为 "document" 或 "code"，默认为 "document"。

📦 安装指南

MCP 协议兼容性说明

• v1.x.x：完全兼容
• v2.0.0+：不支持

💻 使用示例

基础用法

mcp-server run --dataDir ./docs --port 3001

高级用法

# 克隆仓库并安装依赖
git clone https://github.com/your-org/mcp-docs.git && cd mcp-docs && npm install

# 修改配置文件 `docs-mcp.config.json`
{
  "dataDir": "./dist",
  "port": 3000,
  "serverType": "document"
}

# 构建项目
npm run build

# 发布到 npm registry（可选）
npm publish

📚 详细文档

动态配置与环境变量

环境变量优先级

1. 运行时参数
2. 环境变量
3. 构建配置

支持的环境变量

• DATA_DIR
• GLOB_PATTERNS
• PORT
• SERVER_TYPE

创建预构建 MCP 服务器

步骤如下：

1. 克隆仓库

git clone https://github.com/your-org/mcp-docs.git && cd mcp-docs

2. 配置项目 修改 docs-mcp.config.json：

{
  "dataDir": "./src",
  "port": 3000,
  "serverType": "document"
}

更新 package.json 中的名称和其他信息。 3. 构建项目

npm run build

4. 发布到 npm（可选）

npm publish

与 AI 助手集成

工具参数说明

• query：自然语言查询或关键词。
• page：结果页码，默认为 1。

示例工具调用

{
  "tool_name": "search_your_docs",
  "arguments": {
    "query": "如何配置网关",
    "page": 1
  }
}

📄 许可证

本项目采用 MIT 协议。