blue-orange-yellow/scribe-crab
If you are the rightful owner of scribe-crab and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.
scribe-crab is an MCP server that generates documentation comments for Rust functions.
scribe-crab
The MCP server that generates documentation comments for Rust.
Overview
scribe-crab is an MCP (Model Context Protocol) server that helps developers generate documentation comments for their Rust functions. It takes Rust function code as input and produces documentation comments following a customizable format.
Features
- Generate documentation comments for Rust functions
- Use customizable format templates
- Integrate with MCP clients (such as Cursor IDE)
Installation
Clone the repository and build:
git clone https://github.com/blue-orange-yellow/scribe-crab.git
cd scribe-crab
cargo build --release
Configuration
To use with clients like Cursor, you need to configure it as an MCP server. Example Cursor configuration:
{
"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"
}
}
}
}
Usage
- Set the format file path as an environment variable
- Start the MCP server
- Use the tool through an MCP client (like Cursor)
- Ask Cursor Agent "Generate doc comment for XX function" or similar instructions
Documentation Format
The documentation format can be customized by editing the .format.md file.
Example:
/// # Description
///
/// This function does XYZ.
///
/// # Arguments
///
/// * - Description of the first parameter
/// * - Description of the second parameter
///
/// # Returns
///
/// Description of the return value
Languages
This README is also available in:
