Mc MCP

🚀 mc-mcp 项目

mc-mcp 是一个功能强大的工具，可帮助开发者快速初始化项目、创建工具定义并执行工具。它提供了清晰的项目架构和依赖管理方式，让开发者能够高效地进行开发和测试。

🚀 快速开始

初始化新项目

创建一个新的 Cargo.toml 文件并添加以下内容：

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

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

运行以下命令来初始化项目：

cargo generate --from mc-mcp:init

创建工具定义

创建一个名为 src/main.rs 的文件，并添加以下内容：

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()))
    }
}

📦 安装指南

通过以下命令安装 mc-mcp：

cargo install mc-mcp-cli

安装完成后，可以通过运行以下命令来获取帮助信息：

mc-mcp --help

💻 使用示例

基础用法

运行以下命令来执行工具：

mc-mcp run --tool MyAwesomeTool

高级用法

在 src/main.rs 中注册工具：

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

📚 详细文档

配置

项目根目录下需要包含一个 config.rs 文件，内容如下：

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

使用

嵌入工具定义

在 Cargo.toml 中添加以下内容：

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

注册工具

在 src/main.rs 文件的末尾添加以下代码：

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

项目架构

核心组件

• Domain Layer：包含核心业务逻辑、实体和接口。
• Application Layer：定义用例、数据传输对象（DTO）。
• Infrastructure Layer：处理与外部系统的集成，如 Qdrant、嵌入式生成器、文件系统等。

依赖管理

使用手动依赖注入的方式，遵循严格的向内依赖规则：

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

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

开发

代码结构

项目根目录的 Cargo.toml 文件应包含以下内容：

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

resolver = "2"

测试

• 单元测试：使用 cargo test --lib 运行。
• 集成测试：在项目根目录下运行 cargo test --test-integration。

配置管理

创建一个名为 config.rs 的文件，内容如下：

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

依赖管理

在 Cargo.toml 中添加以下内容：

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

项目贡献

提交规范

遵循以下提交规范：

git add .
git commit -m "feat: 添加新功能" # 新功能
git commit -m "fix: 修复已知问题" # 修复问题
git push origin main

代码风格

使用 rustfmt 和 cargo clippy 来保持代码的一致性和可维护性。

文档参考

• Rust 官方文档
• Tokio 官方文档
• Clap 官方文档

📄 许可证

本项目遵循 MIT 许可证。

如需更多信息，请参考项目的 GitHub 仓库或联系维护团队。