文件上下文服务器使用说明

项目简介

本项目 Coding File Context 是一个基于 Model Context Protocol (MCP) 构建的文件上下文服务器，旨在为大型语言模型 (LLM) 提供文件系统级别的上下文信息。通过此服务器，LLM 可以安全、高效地访问和理解本地文件系统中的代码和其他文档，从而更好地执行代码分析、理解和生成等任务。

主要功能点

文件系统操作：
- 读取文件和目录： 支持读取指定路径下的文件和目录内容。
- 文件元数据： 提供文件的详细元数据信息，例如大小、类型、修改时间等。
- 实时文件监控： 能够监控文件系统的变化，并在文件发生更改时自动更新缓存。
- 文件过滤： 支持根据文件类型、路径等条件过滤需要访问的文件。
- 智能缓存： 内置 LRU 缓存机制，有效提高文件访问效率，并支持缓存失效和统计。
代码分析能力：
- 代码质量评估： 能够分析代码的循环复杂度、代码行数、重复行、长行和复杂函数等质量指标。
- 依赖关系提取： 支持提取代码文件中的依赖关系，例如 import 语句。
- 代码结构大纲： 可以生成代码文件的结构大纲，帮助 LLM 理解代码结构。
高级搜索功能：
- 模式搜索： 支持在文件中进行正则表达式模式搜索。
- 上下文搜索： 搜索结果可以包含上下文信息，例如匹配行前后的代码行。

安装步骤

确保已安装 Node.js 和 npm。

打开终端，执行以下命令安装 '@modelcontextprotocol/file-context-server' 包：

npm install @modelcontextprotocol/file-context-server

服务器配置

对于 MCP 客户端，您需要配置以下 JSON 对象以连接到文件上下文服务器。请注意，以下配置为客户端配置，无需用户修改代码。

{
  "serverName": "file-context-server",  // 自定义服务器名称，用于在客户端标识
  "command": "npx",                     // 启动服务器的命令，这里使用 npx 运行本地安装的包
  "args": ["file-context-server"]       // 传递给启动命令的参数，file-context-server 命令本身不需要参数
}

基本使用方法

启动服务器： 在安装成功后，打开终端，执行 'npx file-context-server' 命令即可启动文件上下文服务器。服务器默认通过标准输入/输出 (stdio) 与 MCP 客户端通信。
客户端调用： 在 MCP 客户端中，您可以调用服务器提供的工具来访问文件系统和进行代码分析。以下是一些主要工具及其功能：
- 'read_context': 读取指定路径的文件或目录的内容。
- 'search_context': 在指定路径的文件中搜索特定模式。
- 'get_chunk_count': 获取读取文件或目录内容所需的块数，用于处理大文件分块读取。
- 'set_profile': 设置服务器使用的配置文件，可以切换不同的上下文生成策略。
- 'get_profile_context': 获取基于当前配置文件的项目上下文信息，包括文件列表、代码大纲等。
- 'generate_outline': 生成指定代码文件的结构大纲。
具体工具的参数和使用方法可以参考仓库 'README.md' 文件中 "Available Tools" 部分的详细说明和示例。MCP 客户端根据需要调用这些工具，服务器将返回相应的 JSON-RPC 响应。

关键词