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 倉庫或聯繫維護團隊。