Rust MCP Server

rust-mcp-server is a server that implements the Model Context Protocol (MCP). It acts as a bridge between a large language model (LLM) like GitHub Copilot and your local Rust development environment.

By exposing local tools and project context to the LLM, rust-mcp-server allows the model to perform actions on your behalf, such as building, testing, and analyzing your Rust code.

Table of Contents

• Why use rust-mcp-server?
• Features
  • Core Cargo Commands
  • Project Management
  • Dependency Management
  • Code Quality & Security
  • Rust Toolchain Management
• Getting Started
  • Prerequisites
  • Building the Server
  • Command Line Arguments
  • Configuring with VS Code
• GitHub Copilot Coding Agent Integration
• Documentation Generation
  • Prerequisites
  • Generating Documentation

Why use rust-mcp-server?

Integrating an LLM with your local development environment via rust-mcp-server can significantly enhance your productivity. The LLM can:

• Automate common tasks: Run cargo check, cargo build, cargo test, and cargo fmt directly.
• Manage dependencies: Add new dependencies with cargo add, find unused dependencies with cargo-machete
• Apply Rust best practices: Use cargo clippy to lint your code and catch common mistakes, ensuring adherence to Rust guidelines. The LLM can also leverage other tools to help you write idiomatic and robust Rust code.

Essentially, it turns your AI assistant into an active participant in your development workflow, capable of executing commands and helping you manage your project.

Features

rust-mcp-server exposes a comprehensive set of Rust development tools to the LLM:

Core Cargo Commands

• cargo-build: Compile your package
• cargo-check: Analyze the current package and report errors, but don't build it
• cargo-test: Run the tests
• cargo-fmt: Format the code according to the project's style
• cargo-clippy: Check for common mistakes and improve code quality using Clippy
• cargo-clean: Clean the target directory

Project Management

• cargo-new: Create a new cargo package
• cargo-generate_lockfile: Generate or update the Cargo.lock file
• cargo-list: List installed cargo commands

Dependency Management

• cargo-add: Add dependencies to your Cargo.toml
• cargo-remove: Remove dependencies from your Cargo.toml
• cargo-update: Update dependencies to newer versions
• cargo-metadata: Output project metadata in machine-readable format (JSON)
• cargo-search: Search for packages in the registry
• cargo-info: Display information about a package

Code Quality & Security

• cargo-deny-check: Check for security advisories, license compliance, and banned crates
• cargo-deny-init: Create a cargo-deny config from a template
• cargo-deny-list: List all licenses and the crates that use them
• cargo-deny-install: Install cargo-deny tool
• cargo-machete: Find unused dependencies
• cargo-machete-install: Install cargo-machete tool
• cargo-hack: Advanced testing and feature validation with powerset testing, version compatibility checks, and CI optimization
• cargo-hack-install: Install cargo-hack tool

Rust Toolchain Management

• rustup-show: Show the active and installed toolchains
• rustup-toolchain-add: Install or update toolchains
• rustup-update: Update Rust toolchains and rustup

For a complete list with detailed descriptions and parameters, see tools.md.

Getting Started

Prerequisites

1. Rust: You need the Rust toolchain installed. You can get it from rustup.rs.
2. [Optional] cargo-deny: Install with cargo install cargo-deny.
3. [Optional] cargo-machete: Install with cargo install cargo-machete.

Building the Server

1. Clone this repository.
2. Build the server in release mode:

   cargo build --release
   

   The executable will be located at target/release/rust-mcp-server.exe.

Command Line Arguments

The rust-mcp-server supports several command line arguments to customize its behavior:

--timeout <TIMEOUT>

• Description: Sets the timeout for processing a request in seconds
• Type: Integer
• Default: 600 (10 minutes)
• Example: --timeout 300 (5 minutes)

--log-level <LOG_LEVEL>

• Description: Sets the logging level for the server
• Type: String
• Options: error, warn, info, debug, trace
• Default: info
• Example: --log-level debug

--log-file <LOG_FILE>

• Description: Specifies a file path for logging output. If not provided, logs are written to stderr
• Type: String (file path)
• Default: None (logs to stderr)
• Example: --log-file /var/log/rust-mcp-server.log

--disable-tool <TOOL_NAME>

• Description: Disables a specific tool by name. Can be specified multiple times to disable multiple tools
• Type: String (tool name)
• Default: None (all tools enabled)
• Example: --disable-tool cargo-test --disable-tool cargo-clippy

--workspace <WORKSPACE>

• Description: Specifies the Rust project workspace path for the server to operate in
• Type: String (directory path)
• Default: Current directory
• Example: --workspace /path/to/rust/project

-h, --help

• Description: Displays help information about available command line arguments
• Example: rust-mcp-server --help

-V, --version

• Description: Displays the version information of the server
• Example: rust-mcp-server --version

Usage Examples

Basic usage with default settings:

rust-mcp-server

With custom timeout and debug logging:

rust-mcp-server --timeout 300 --log-level debug

With file logging and disabled tools:

rust-mcp-server --log-file /tmp/mcp-server.log --disable-tool cargo-test

With custom workspace directory:

rust-mcp-server --workspace /path/to/rust/project

Configuring with VS Code

To make GitHub Copilot in VS Code use this MCP server, you need to update your VS Code settings.

1. Enable MCP server in VS Code settings - ⚙️chat.mcp.enabled

2. Add new MCP server into .vscode/mcp.json.

   {
       "servers": {
           "rust-mcp-server": {
               "type": "stdio",
               "command": "C:/path/to/your/rust-mcp-server.exe",
               "args": ["--log-file", "log/folder/rust-mcp-server.log"],
           }
       }
   }
   

3. Start the server

More information you can find by this link.

GitHub Copilot Coding Agent Integration

The Rust MCP Server can be integrated with GitHub Copilot's coding agent to create a powerful autonomous development workflow. For detailed setup instructions for using the Rust MCP Server with GitHub Copilot's coding agent, see copilot-coding-agent.md.

Documentation Generation

This project uses mcp-discovery to automatically generate comprehensive documentation of all available MCP tools and capabilities.

Prerequisites

Install mcp-discovery:

cargo install mcp-discovery

Generating Documentation

Run the documentation generation script to update the tools documentation:

python scripts/generate-docs.py

This will regenerate tools.md with the latest tool descriptions and capabilities.