Document Archive MCP Server

🚀 MCP 服務器

MCP 服務器是一個基於 Node.js 和 TypeScript 實現的應用，藉助 Model Context Protocol (MCP) 開放協議，能讓 AI 應用程序與各類數據源和工具實現無縫通信，為應用向大型語言模型 (LLM) 提供標準化的上下文交互方案。

🚀 快速開始

依賴項

本項目依賴於 Node.js 22+ 和 npm，請確保你的環境中已安裝這些工具。

安裝

按照以下步驟完成項目的安裝：

1. 克隆項目倉庫：

git clone [項目倉庫地址]

2. 安裝項目依賴：

npm install

3. 構建項目：

npm run build

運行服務器

基礎用法

使用 stdio 方式運行服務器，適用於與 MCP 客戶端整合：

npm start

高級用法

使用 SSE 方式運行服務器，適用於 Web 應用場景：

npm start -- --transport=sse

服務器默認運行在 3000 端口，你可以通過以下兩種方式修改端口：

npm start -- --transport=sse --port=8080

或者設置環境變量：

PORT=8080 npm start -- --transport=sse

✨ 主要特性

本服務器實現了一系列實用功能，具體如下：

• 跨文檔搜索：提供強大的跨文檔搜索工具，可快速檢索相關信息。
• 文檔管理：支持文檔列表展示和元數據資源管理。
• 文檔問答：提供文檔 Q&A 提示模板，方便回答有關文檔的問題。
• 傳輸方式：支持 stdio 和 SSE 兩種傳輸方法。
• 日誌系統：具備全面的日誌記錄系統，便於問題排查和監控。
• 環境配置：支持通過環境變量進行配置。
• 路徑管理：確保所有服務初始化完成後才接受請求。
• 平滑關閉：提供平滑關閉處理機制，用於服務器終止。

📦 安裝指南

依賴項

• Node.js 22+ 和 npm

安裝步驟

1. 克隆項目倉庫：

git clone [項目倉庫地址]

2. 安裝依賴：

npm install

3. 構建項目：

npm run build

💻 使用示例

基礎用法

使用 stdio 方式運行服務器：

npm start

高級用法

使用 SSE 方式運行服務器，並指定端口：

npm start -- --transport=sse --port=8080

📚 詳細文檔

API 文檔

工具類 API

• getDocumentsMetadata：用於檢索可用文檔的元數據。
  • 參數：
    • query (string)：用戶的原始查詢或問題。
• checkQueryRelevance：評估相關文檔並返回 intent 分析的指令。
  • 參數：
    • query (string)：用戶的原始查詢或問題。
    • files (Array)：與查詢相關聯的文件路徑列表。
• getDocumentMetadata：根據文件路徑檢索特定文檔的元數據。
  • 參數：
    • file (string)：文件路徑。

資源類 API

• /:path：用於處理所有其他路由請求，返回 "default.html"。

🔧 技術細節

系統架構

本項目的系統架構圖如下：

開發模式

若你需要在開發模式下運行服務器並啟用自動重新加載功能，可使用以下命令：

npm run dev

若要在開發模式下使用 SSE 傳輸方式，可使用以下命令：

npm run dev -- --transport=sse

📄 許可證

本項目採用 MIT 許可證。