MCP Toolkit

🚀 MCP 工具包

MCP 工具包是一套全面的模型上下文協議（MCP）服務器實現方案，提供了豐富多樣的工具集。藉助它，AI 助手能夠與本地系統、文件、數據庫以及外部服務進行交互，在擴展 AI 現實世界交互能力的同時，確保安全性與可控性。

🚀 快速開始

MCP 工具包可幫助 AI 助手與多種系統和服務交互。以下是快速使用的步驟：

安裝

npm install mcp-toolkit

配置

在項目中創建一個 config.json 文件：

{
  "workspace": {
    "rootPath": "/path/to/workspace",
    "allowedPaths": ["/allowed/path1", "/allowed/path2"]
  },
  "network": {
    "proxy": "http://proxy-server:port" // 可選配置
  },
  "database": {
    "mysql": {
      "host": "localhost",
      "port": 3306,
      "user": "user",
      "password": "password",
      "database": "dbname"
    }
    // 類似地為 PostgreSQL 和 Redis 配置
  }
}

使用

import { Server } from 'mcp-toolkit';

const server = new Server({
  configPath: './config.json'
});

server.start();

✨ 主要特性

• 文件系統操作
  • 支持讀取和寫入文件，創建和刪除目錄。
  • 可使用正則表達式搜索文件，列出目錄內容，提取代碼定義。
• 數據庫集成
  • 支持 MySQL、PostgreSQL 和 Redis 數據庫。
  • 具備事務管理和參數化查詢功能。
• GitHub 集成
  • 可進行倉庫管理、代碼搜索、文件操作和倉庫結構分析。
• 網絡能力
  • 能提取網頁內容，集成 Brave 搜索，處理 HTTP 請求，支持代理。
• 系統工具
  • 可執行命令，集成 Everything 搜索，進行棧跟蹤分析和日誌記錄。

📦 安裝指南

npm install mcp-toolkit

💻 使用示例

基礎用法

import { Server } from 'mcp-toolkit';

const server = new Server({
  configPath: './config.json'
});

server.start();

📚 詳細文檔

工具詳情

文件操作工具

• read_file: 讀取文件內容，支持文本和二進制文件。
• write_to_file: 寫入或創建文件。
• apply_diff: 應用差異修改到文件。
• insert_content: 在指定位置插入內容。
• search_and_replace: 搜索並替換文件內容。
• list_files: 列出目錄內容。
• search_files: 使用正則表達式搜索文件。
• list_code_definition_names: 提取代碼定義。

數據庫工具

• db_connect: 連接數據庫（MySQL/PostgreSQL/Redis）。
• db_query: 執行數據庫查詢。
• db_begin_transaction: 開始事務。
• db_commit_transaction: 提交事務。
• db_rollback_transaction: 回滾事務。
• db_close: 關閉數據庫連接。

GitHub 工具

• github_ls: 列出倉庫內容。
• github_tree: 顯示倉庫結構。
• github_search_repo: 搜索倉庫。
• github_search_code: 搜索代碼。
• github_cat: 查看文件內容。
• github_list_repos: 列出用戶倉庫。
• github_create_repo: 創建倉庫。
• github_update_repo: 更新倉庫設置。
• github_delete_repo: 刪除倉庫。

網絡工具

• read_webpage: 提取網頁內容。
• brave_search: 使用 Brave 搜索。
• http_request: 發送 HTTP 請求。

系統工具

• execute_command: 執行系統命令。
• everything_search: 本地文件搜索。
• logger: 日誌記錄。
• stack_trace: 棧跟蹤。

🔧 技術細節

MCP 工具包支持配置安全措施，例如通過設置代理和限制訪問路徑來保護您的數據和網絡。

📄 許可證

MCP 工具包遵循 MIT License。

🌟 貢獻指南

我們歡迎社區對 MCP 工具包的貢獻！請參考我們的 貢獻指南 瞭解如何參與開發。