Mc MCP

🚀 mc-mcp Project Introduction

The mc-mcp project is a powerful tool that simplifies the development process. It provides a set of functions and configurations to help users quickly build and run tools.

🚀 Quick Start

Initialize a New Project

Create a new Cargo.toml file and add the following content:

[package]
name = "my-tool"
version = "0.1.0"
edition = "2021"

[dependencies]
tool-derive = { version = "0.1", features = ["runtime"] }

Run the following command to initialize the project:

cargo generate --from mc-mcp:init

Create a Tool Definition

Create a file named src/main.rs and add the following content:

use tool_sdk::prelude::*;

#[tool]
struct MyAwesomeTool;

impl Tool for MyAwesomeTool {
    fn name(&self) -> &'static str {
        "My Awesome Tool"
    }

    fn description(&self) -> Option<&'static str> {
        Some("Does something awesome.")
    }

    async fn run(
        &self,
        _context: Context,
        _args: Vec<String>,
    ) -> Result<ToolOutput, ToolError> {
        Ok(ToolOutput::success("Awesome!".to_string()))
    }
}

📦 Installation

Install mc-mcp using the following command:

cargo install mc-mcp-cli

After the installation is complete, you can run the following command to get help information:

mc-mcp --help

💻 Usage Examples

Basic Usage

Run the following command to execute the tool:

mc-mcp run --tool MyAwesomeTool

Advanced Usage

In the src/main.rs file, register the tool:

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Register the tool
    register_tool!(MyAwesomeTool);
    
    Ok(())
}

📚 Documentation

Configuration

The project root directory needs to contain a config.rs file with the following content:

#[derive(Debug, Clone, Figment)]
pub struct Settings {
    #[default(String::from("qdrant"))]
    pub qdrant_url: String,
    
    #[default(40_000)]
    pub max_open_files: usize,
}

Usage

Embed Tool Definition

Add the following content to Cargo.toml:

[workspace.dependencies]
tool_sdk = { path = "../mc-mcp" }

Register Tool

Add the following code to the end of the src/main.rs file:

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Register the tool
    register_tool!(MyAwesomeTool);
    
    Ok(())
}

🔧 Technical Details

Project Architecture

Core Components

• Domain Layer: Contains core business logic, entities, and interfaces.
• Application Layer: Defines use cases and data transfer objects (DTO).
• Infrastructure Layer: Handles integration with external systems, such as Qdrant, embedded generators, file systems, etc.

Dependency Management

Use manual dependency injection and follow strict inward dependency rules:

use domain::repositories::UserRepository;
use infrastructure::qdrant::QdrantClient;

#[inject]
struct MyService {
    userRepository: UserRepository,
    vectorStore: QdrantClient,
}

Development

Code Structure

The Cargo.toml file in the project root directory should contain the following content:

[workspace.members]
members = [
    "mc-mcp",
    "test-fixtures"
]

resolver = "2"

Testing

• Unit Tests: Use cargo test --lib to run.
• Integration Tests: Run cargo test --test-integration in the project root directory.

Dependency Management

Add the following content to Cargo.toml:

[dependencies]
tokio = { version = "1.0", features = ["full"] }
clap = { version = "3.2", features = ["derive"] }
figment = "0.6"

Project Contribution

Commit Specification

Follow the following commit specification:

git add .
git commit -m "feat: Add a new feature" # New feature
git commit -m "fix: Fix a known issue" # Fix an issue
git push origin main

Code Style

Use rustfmt and cargo clippy to maintain code consistency and maintainability.

Documentation References

• Rust Official Documentation
• Tokio Official Documentation
• Clap Official Documentation

📄 License

This project is licensed under the MIT License.

For more information, please refer to the project's GitHub repository or contact the maintenance team.