Bsmi021 MCP File Context Server

🚀 文件上下文服務器

文件上下文服務器是一個基於模型上下文協議（MCP）的服務器，專為大型語言模型（LLMs）提供文件系統上下文。它賦予了LLMs讀取、搜索和分析代碼文件的能力，同時具備高級緩存和即時文件監控等實用功能。

🚀 快速開始

文件上下文服務器能幫助大型語言模型更好地與文件系統交互，通過它可以輕鬆實現文件操作、代碼分析等功能。以下是啟動服務器的命令：

npx file-context-server

✨ 主要特性

文件操作

• 讀取內容：可讀取文件和目錄的具體內容。
• 列出文件：能列出文件及其詳細的元數據。
• 即時監控：對文件進行即時監控，當文件有變動時會使緩存無效化。
• 編碼支持：支持多種文件編碼。
• 遞歸遍歷：能夠遞歸遍歷目錄。
• 類型篩選：可根據文件類型進行篩選。

代碼分析

• 複雜度計算：計算代碼的環狀複雜度。
• 依賴提取：提取代碼中的依賴項。
• 註釋分析：對代碼中的註釋進行分析。
• 質量指標：包含重複行檢測、長行檢測（>100字符）、複雜函數識別以及行數統計（總數、非空行、註釋行）。

智能緩存

• 緩存策略：採用最近最少使用（LRU）緩存策略。
• 自動無效化：當文件更改時，自動使緩存無效化。
• 大小限制：緩存帶有大小限制，支持配置上限。
• 統計指標：提供緩存統計和性能指標。
• 結果緩存：緩存最近的讀取結果以優化搜索。

高級搜索

• 模式匹配：支持正則表達式模式匹配。
• 上下文行數：搜索結果可配置上下文行數。
• 類型過濾：支持文件類型過濾。
• 多模式搜索：支持多個模式的搜索。
• 緩存結果搜索：可搜索緩存結果。
• 排除模式：支持排除特定模式。

📦 安裝指南

使用以下命令安裝文件上下文服務器：

npm install @modelcontextprotocol/file-context-server

💻 使用示例

基礎用法

列出目錄中的文件及其詳細元數據

{
  "path": "./src",
  "recursive": true,
  "includeHidden": false
}

讀取文件或目錄內容及元數據

{
  "path": "./src/index.ts",
  "encoding": "utf8",
  "maxSize": 1000000,
  "recursive": true,
  "fileTypes": ["ts", "js"]
}

在文件中搜索模式並獲取上下文

{
  "pattern": "function.*",
  "path": "./src",
  "options": {
    "recursive": true,
    "contextLines": 2,
    "fileTypes": ["ts"]
  }
}

分析代碼文件的質量指標

{
  "path": "./src",
  "recursive": true,
  "metrics": ["complexity", "dependencies", "quality"]
}

獲取緩存統計信息和性能指標

{
  "detailed": true
}

📚 詳細文檔

錯誤處理

服務器會提供詳細的錯誤消息，並附帶具體的錯誤代碼：

• FILE_NOT_FOUND：文件或目錄不存在。
• PERMISSION_DENIED：訪問權限存在問題。
• INVALID_PATH：文件路徑格式無效。
• FILE_TOO_LARGE：文件過大。
• INTERNAL_ERROR：內部服務器出現錯誤。

配置

可通過以下環境變量對服務器進行配置：

MAX_CACHE_SIZE=1000  # 設置最大緩存條目數
CACHE_EXPIRATION=3600  # 設置緩存過期時間（秒）

開發

若要進行開發，可按以下步驟操作：

git clone [倉庫地址]
cd 文件上下文服務器
npm install
npm start

📄 許可證

[此處填寫許可證信息]

🤝 貢獻指南

[此處填寫貢獻指南]