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

📄 许可证

[此处填写许可证信息]

🤝 贡献指南

[此处填写贡献指南]