🚀 文档 - mcp-server

本项目提供了 docs-mcp-server 工具，可用于初始化、启动 MCP 服务器以及构建项目，同时支持自动化发布流程。

🚀 快速开始

安装

通过以下命令安装 docs-mcp-server：

npm install -g docs-mcp-server

使用命令行工具

安装完成后，可以通过以下命令使用：

npx docs-mcp-server <command> [options]

可用的命令包括：

• init：初始化一个新的 MCP 服务器配置文件。
• serve：启动 MCP 服务器。
• build：构建项目。

更多详细信息请参考 docs-mcp-server --help。

环境配置

创建一个基于 .env.example 的 .env 文件：

cp .env.example .env

更新你的 OpenAI API 密钥到 .env 文件中：

# 必须：你的 OpenAI API 密钥。
OPENAI_API_KEY=your-api-key-here

# 可选：你的 OpenAI 组织 ID（由 LangChain 自动处理）
OPENAI_ORG_ID=

# 可选：OpenAI API 的自定义基础 URL（例如用于 Azure OpenAI 或兼容的 API）
OPENAI_API_BASE=

# 可选：嵌入式模型名称（默认为 "text-embedding-3-small"）
# 示例：text-embedding-3-large, text-embedding-ada-002
DOCS_MCP_EMBEDDING_MODEL=

# 可选：指定一个自定义目录来存储 SQLite 数据库文件（documents.db）。
# 如果未设置，默认行为如下：
# 1. 使用项目根目录中的 './.store/'（如果存在，则为旧版）。
# 2. 回退到操作系统特定的数据目录（例如 macOS 中的 ~/Library/Application Support/docs-mcp-server）。
DOCS_MCP_STORE_PATH=/path/to/your/desired/storage/directory

📦 安装指南

通过以下命令全局安装 docs-mcp-server：

npm install -g docs-mcp-server

💻 使用示例

基础用法

使用命令行工具执行基本操作：

# 初始化新的 MCP 服务器配置文件
npx docs-mcp-server init

# 启动 MCP 服务器
npx docs-mcp-server serve

# 构建项目
npx docs-mcp-server build

📚 详细文档

发布

该项目使用 semantic-release 和 Conventional Commits 来自动化发布流程。

工作原理：

1. 提交信息：所有合并到 main 分支的提交必须遵循 Conventional Commits 规范。
2. 手动触发：当准备好了新的版本时，可以从 GitHub Actions 的操作选项卡中手动触发“发布”工作流。
3. semantic-release 动作：确定版本号、更新 CHANGELOG.md 和 package.json、提交更改、打标签、向 npm 发布，并创建 GitHub 发布。

你需要做的：

• 使用 Conventional Commits 格式的提交信息。
• 将更改合并到 main 分支。
• 准备好后，从 Actions 部分手动触发新的发布。

自动化处理内容：

• Changelog 更新
• 版本号调整
• 打标签
• npm 发布
• GitHub 发布创建

项目架构

关于该项目的架构和设计原理，请参阅 ARCHITECTURE.md。

特别说明

特别注意，这个项目的大部分代码是由 AI 助手 Cline 使用此 MCP 服务器的功能生成的。