关键词

Rust代码分析开发者工具代码质量编程辅助

使用说明

项目简介

rust-mcp-toolkit 是一个 MCP (Model Context Protocol) 服务器，它作为一个 Rust 编程助手，通过 MCP 协议向支持 MCP 协议的客户端（如 Claude Desktop）提供 Rust 代码分析和辅助功能。它提供了一系列工具，用于分析 Rust 代码的潜在问题、改进代码质量和提升开发效率。

主要功能点

  • 代码分析工具: 提供多种 Rust 代码分析工具，例如：
    • 'analyze_rust': 基础代码错误和警告分析。
    • 'suggest_improvements': 提出代码改进建议。
    • 'profile_performance': 性能分析和 profiling。
    • 'analyze_memory_safety': 内存安全问题检查。
    • 'lint_code': 使用 Clippy 进行代码 Lint 检查。
    • 'expand_macros': 宏展开分析。
    • 'analyze_macro_hygiene': 宏卫生性分析。
    • 'visualize_borrow_checker': 可视化借用检查器规则。
    • 'visualize_ownership': 可视化所有权关系。
    • 'debug_async_tasks': 异步任务调试。
  • 代码辅助工具: 提供代码格式化、测试用例生成等辅助功能。
    • 'format_code': 使用 rustfmt 格式化代码。
    • 'generate_tests': 生成测试用例。
    • 'run_benchmarks': 运行性能基准测试。
    • 'manage_dependencies': 依赖管理和优化。
    • 'analyze_dependencies': 依赖关系分析。
  • 参考资源: 提供 Rust 相关的参考资源，例如：
    • 'rust://reference/common-errors': 常见 Rust 错误参考。
    • 'rust://guide/best-practices': Rust 最佳实践指南。
    • 'rust://reference/lifetimes': Rust 生命周期参考。
    • 'rust://error/{errorCode}': 特定错误码的详细解释模板。
    • 'rust://pattern/{patternName}': 常见 Rust 模式参考模板。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node 包管理器)。
  2. 下载仓库代码: 克隆或下载 rust-mcp-toolkit 仓库到本地。
  3. 安装依赖: 在仓库根目录下，打开终端并运行 'npm install' 命令安装项目依赖。 
    npm install
  4. 构建项目: 运行 'npm run build' 命令构建项目，将 TypeScript 代码编译为 JavaScript。 
    npm run build

服务器配置

要将 rust-mcp-toolkit MCP 服务器添加到 MCP 客户端（例如 Claude Desktop），你需要配置客户端的服务器配置文件。

以 Claude Desktop 为例：

  1. 找到配置文件: 根据你的操作系统，找到 Claude Desktop 的配置文件 'claude_desktop_config.json'。

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

  2. 编辑配置文件: 打开 'claude_desktop_config.json' 文件，在 'mcpServers' 字段中添加 rust-mcp-toolkit 服务器的配置。如果 'mcpServers' 字段不存在，请创建它。

    {
  "mcpServers": {
    "rust-assistant": {  // 服务器名称，可以自定义
      "command": "/path/to/rust-mcp-toolkit/build/index.js"  //  **[请替换为实际路径]** 指向 'build/index.js' 文件的绝对路径
    }
  }
}

    重要: 请将 '/path/to/rust-mcp-toolkit/build/index.js' 替换为你本地 rust-mcp-toolkit 仓库 'build/index.js' 文件的绝对路径。 例如，如果你的仓库在 '~/Documents/rust-mcp-toolkit'，则路径可能为 '/Users/你的用户名/Documents/rust-mcp-toolkit/build/index.js' (macOS) 或 'C:\Users\你的用户名\Documents\rust-mcp-toolkit\build\index.js' (Windows)。

基本使用方法

  1. 启动 MCP 服务器: 配置完成后，当 MCP 客户端（如 Claude Desktop）启动时，rust-mcp-toolkit MCP 服务器将自动启动并与客户端建立连接。
  2. 在 MCP 客户端中使用工具和资源: 在 MCP 客户端中，你应该能够发现并使用 rust-mcp-toolkit 服务器提供的工具和资源。具体使用方式取决于 MCP 客户端的功能和界面。例如，在 Claude Desktop 中，你可能可以通过特定的界面或指令来调用这些 Rust 代码分析和辅助工具，或者访问提供的 Rust 参考资源。

调试

如果需要调试 MCP 服务器，可以使用 README 中推荐的 MCP Inspector 工具。运行 'npm run inspector' 命令可以启动 Inspector，它提供了一个浏览器界面用于调试 MCP 服务器的通信和请求。

信息

分类

开发者工具

访问项目