Docs MCP Server

🚀 文檔 - 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 服務器的功能生成的。