scribe-crab

基本能力

产品定位

scribe-crab 是一个专注于为 Rust 函数生成文档注释的工具，旨在提高开发效率和代码可读性。

核心功能

• 为 Rust 函数生成文档注释
• 支持自定义格式模板
• 可与 MCP 客户端（如 Cursor IDE）集成

适用场景

• 开发者在编写 Rust 代码时需要快速生成文档注释
• 团队希望统一文档注释格式以提高代码可读性
• 集成到开发工具（如 Cursor IDE）中以实现自动化文档生成

工具列表

• scribe-crab：主服务，用于生成文档注释

常见问题解答

• 如何自定义文档格式？ 通过编辑 .format.md 文件来自定义文档注释格式。
• 如何与 Cursor IDE 集成？ 在 Cursor 配置文件中添加 scribe-crab 的 MCP 服务器配置。

使用教程

使用依赖

• Rust 环境（需安装 cargo）

安装教程

1. 克隆仓库并构建：

git clone https://github.com/blue-orange-yellow/scribe-crab.git
cd scribe-crab
cargo build --release

1. 配置 MCP 服务器（以 Cursor 为例）：

{
  "mcpServers": {
    "scribe-crab": {
      "command": "/path/to/scribe-crab/target/release/scribe-crab",
      "args": [],
      "cwd": "/path/to/scribe-crab",
      "env": {
        "FORMAT_PATH": "/path/to/scribe-crab/.format.md"
      }
    }
  }
}

调试方式

1. 设置格式文件路径环境变量：

export FORMAT_PATH="/path/to/scribe-crab/.format.md"

1. 启动 MCP 服务器：

./target/release/scribe-crab

1. 通过 MCP 客户端（如 Cursor）使用工具，输入指令如 "Generate doc comment for XX function"。

许可证

None