关键词

AI上下文项目管理文件操作LLM工具代码分析

项目简介

'claude-faf-mcp' 是一个基于 Model Context Protocol (MCP) 构建的服务器实现，旨在为大型语言模型（LLM）提供标准化的项目上下文信息和丰富的操作能力。它通过托管和管理项目资源（'.faf'文件），提供超过33个工具供LLM调用，并以F1赛车级性能提供AI就绪度评分，帮助LLM更好地理解和交互项目代码。其核心是"FAF"（Foundational AI Context Format），旨在成为AI领域的JPEG，使任何AI都能轻松读取和理解项目DNA。

主要功能点

  • AI就绪度评分: 评估项目的AI可读性，提供F1赛车主题的评分系统和改进建议，旨在达到100%甚至105%的“Big Orange”状态。
  • 项目上下文管理: 通过'.faf'文件作为项目AI上下文的核心，支持创建、管理和分析项目“DNA”，确保AI对项目有全面深入的理解。
  • 丰富的工具集: 提供超过33个工具，涵盖文件读写、目录列表、项目初始化、AI优化、代码分析、信任验证、文件同步和双向同步等，允许LLM直接执行复杂的开发和管理任务。
  • 高速性能: 强调“冠军级性能”，核心操作响应时间低于50毫秒，部分操作甚至达到毫秒级，确保AI交互的流畅性。
  • 多传输协议支持: 支持Stdio和HTTP/SSE两种传输协议，确保与不同MCP客户端（如Claude Desktop）的兼容性和灵活性。
  • 安全的文件操作: 提供对本地文件系统的安全访问能力，并内置路径遍历和文件大小限制等安全机制，保护您的项目数据。
  • 无壳执行与原生TypeScript: 核心功能采用原生TypeScript实现，减少对外部CLI工具的依赖，提升服务器的稳定性、性能和可维护性。
  • 上下文镜像（Context-Mirroring）: 实现'.faf'文件与'CLAUDE.md'文件的双向同步，确保LLM始终拥有最新的项目上下文，并能将AI的洞察同步回项目文档。

安装步骤

  1. 安装Node.js: 确保您的系统已安装Node.js 18或更高版本。这是运行'claude-faf-mcp'服务器所必需的。
  2. 全局安装FAF MCP服务器: 打开终端或命令行界面，运行以下命令： 
    npm install -g claude-faf-mcp
    这条命令将会在您的系统上全局安装'claude-faf-mcp'作为可执行命令。
  3. 安装Claude Desktop (可选): 如果您计划将此MCP服务器与Anthropic的Claude Desktop客户端集成，请确保您已安装最新版本的Claude Desktop。

服务器配置 (针对MCP客户端)

MCP服务器需要被您的MCP客户端（例如Claude Desktop）识别并启动。以下是针对Claude Desktop的配置说明，您需要在其配置文件中添加相应的MCP服务器条目。

配置文件路径示例:

  • macOS/Linux: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%\Claude\claude_desktop_config.json'

请在此JSON文件中找到或创建一个名为'"mcpServers"'的字段，并添加以下配置：

{
  "mcpServers": {
    "claude-faf-mcp": {
      "command": "claude-faf-mcp"
    }
  }
}
  • '"claude-faf-mcp"': 这是您给该MCP服务器定义的唯一名称。MCP客户端将通过此名称来识别和引用此服务器。
  • '"command"': 指定用于启动MCP服务器的可执行命令。这里设置为全局安装的'claude-faf-mcp'命令。

保存配置文件后，请重启Claude Desktop。客户端将自动发现并连接到新配置的MCP服务器，并声明其提供的所有工具和资源。

基本使用方法

  1. 启动MCP客户端: 启动您的MCP客户端（例如Claude Desktop）。客户端将自动连接并声明'claude-faf-mcp'服务器提供的工具。
  2. 初始化项目上下文 ('faf_init' 或 'faf_auto'):
    • 在客户端对话中，您可以调用'faf_init'工具来为您的项目创建AI上下文文件（'.faf'文件）。例如： 
      Call faf_init with {"directory": "/path/to/your/project"}
    • 或者，将您项目中的任何文件拖放到客户端对话中，然后输入："Run faf_auto to analyze this project"（运行'faf_auto'来分析这个项目）。服务器将自动检测项目结构、技术栈，并创建'.faf'和'CLAUDE.md'文件。
  3. 获取AI就绪度评分 ('faf_score'): 要了解项目的AI就绪度，您可以调用'faf_score'工具： 
    Call faf_score with {"details": true}
    服务器将返回详细的评分报告，包括F1赛车主题的状态、当前分数和改进建议。
  4. 文件操作 ('faf_read', 'faf_write' 等): 您可以使用'faf_read'和'faf_write'等工具来直接读写项目文件。例如： 
    Call faf_read with {"path": "src/main.ts"}
    Call faf_write with {"path": "docs/new_feature_notes.md", "content": "This is a new note about upcoming features."}
  5. 与Claude交互: 一旦项目上下文通过FAF MCP服务器被初始化并同步，Claude就能更深入地理解您的项目。您可以继续通过自然语言与Claude对话，让它调用各种'faf'工具来辅助您的开发、分析和管理工作。

信息

分类

开发者工具

访问项目