🚀 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 工具包的贡献！请参考我们的 贡献指南 了解如何参与开发。