Scribe Crab
What is Scribe Crab
scribe-crab is an MCP (Model Context Protocol) server designed to help developers generate documentation comments for their Rust functions.
Use cases
Use cases for scribe-crab include generating documentation for Rust libraries, assisting in code reviews by providing clear function documentation, and enhancing developer productivity by automating the documentation process.
How to use
To use scribe-crab, set the format file path as an environment variable, start the MCP server, and interact with it through an MCP client like Cursor by issuing commands such as ‘Generate doc comment for XX function’.
Key features
Key features of scribe-crab include generating documentation comments for Rust functions, using customizable format templates, and integrating with MCP clients such as Cursor IDE.
Where to use
scribe-crab can be used in software development environments where Rust programming is prevalent, particularly in projects that require well-documented code.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Overview
What is Scribe Crab
scribe-crab is an MCP (Model Context Protocol) server designed to help developers generate documentation comments for their Rust functions.
Use cases
Use cases for scribe-crab include generating documentation for Rust libraries, assisting in code reviews by providing clear function documentation, and enhancing developer productivity by automating the documentation process.
How to use
To use scribe-crab, set the format file path as an environment variable, start the MCP server, and interact with it through an MCP client like Cursor by issuing commands such as ‘Generate doc comment for XX function’.
Key features
Key features of scribe-crab include generating documentation comments for Rust functions, using customizable format templates, and integrating with MCP clients such as Cursor IDE.
Where to use
scribe-crab can be used in software development environments where Rust programming is prevalent, particularly in projects that require well-documented code.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Content
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:
Dev Tools Supporting MCP
The following are the main code editors that support the Model Context Protocol. Click the link to visit the official website for more information.
