Documentation MCP Server

🚀 文檔 MCP 服務器

一個供開發人員訪問其最喜歡的庫的最新文檔的服務器，為開發人員提供了統一接口，可訪問各種庫的最新文檔，聚合多源信息，支持搜索篩選，確保獲取最新內容。

🚀 快速開始

此 MCP（模型 - 控制器 - 呈現器）服務器為開發人員提供了一個統一接口，用於訪問各種庫的最新文檔。它從多個來源聚合文檔，支持在所有庫上搜索或按特定庫篩選，並確保開發人員可以獲取到最新的信息。

✨ 主要特性

• 文檔聚合：從多個庫來源收集文檔
• 搜索功能：在所有庫或特定庫上進行搜索
• 版本管理：訪問不同版本庫的文檔
• 自動更新：定期獲取最新文檔
• API 訪問：通過 API 進行程序化文檔訪問
• 交互式 UI：用於瀏覽文檔的網絡界面

📦 安裝指南

使用安裝腳本

最簡單的入門方法：

# 克隆倉庫
git clone https://github.com/SubaashNair/documentation-mcp-server.git
cd documentation-mcp-server

# 使安裝腳本可執行
chmod +x install.sh

# 運行安裝腳本
./install.sh

使用 Docker

# 克隆倉庫
git clone https://github.com/SubaashNair/documentation-mcp-server.git
cd documentation-mcp-server

# 構建鏡像（如果需要）
docker build -t documentation-mcp .

# 運行容器
docker run -p 3000:3000 documentation-mcp

💻 使用示例

基礎用法

安裝依賴項

npm install

啟動服務器

node index.js

訪問 http://localhost:3000 使用文檔。

高級用法

Docker 方式啟動

docker run -p 3000:3000 documentation-mcp

然後訪問 http://localhost:3000 使用文檔。

📚 詳細文檔

• 安裝指南 - 詳細的設置說明
• API 文檔 - OpenAPI 文檔（運行服務器時訪問）
• 貢獻指南 - 如何為項目做出貢獻

📄 許可證

此項目使用 MIT 許可證 - 請查看 LICENSE 文件以獲取詳細信息。

致謝

• 文檔和 API 設計靈感來自 DevDocs
• 架構模式來自 Express.js
• 搜索功能由 Lunr.js 提供支持

路線圖

• [ ] 添加更多庫的支持（如 TypeScript、Node.js 等）
• [ ] 實現用戶賬戶和收藏功能
• [ ] 添加離線文檔支持
• [ ] 創建一個 CLI 工具以訪問文檔
• [ ] 實現社區貢獻文檔的功能

貢獻

歡迎貢獻！請隨意提交 Pull Request。

1. 叉克倉庫
2. 創建你的功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m '添加一些神奇的功能'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 打開 Pull Request