README_zh.md•3.21 kB
# MCP Toolkit
[English](README.md) | 中文
## 概述
MCP Toolkit 是一个完整的模型上下文协议(MCP)服务器实现，为 AI 助手提供了丰富的工具集，用于与本地系统、文件、数据库和外部服务进行交互。它旨在通过实际操作扩展 AI 的能力，同时保持安全性和控制性。
## 功能特性
- **文件系统操作**
- 读写文件
- 创建和删除目录
- 正则表达式文件搜索
- 目录内容列表
- 代码定义提取
- **数据库集成**
- MySQL 支持
- PostgreSQL 支持
- Redis 支持
- 事务管理
- 参数化查询
- **GitHub 集成**
- 仓库管理
- 代码搜索
- 文件操作
- 树结构分析
- **Web 功能**
- 网页内容提取
- Brave 搜索集成
- HTTP 请求处理
- 代理支持
- **系统工具**
- 命令执行
- Everything 搜索集成
- 堆栈跟踪分析
- 日志系统
## 安装
```bash
npm install mcp-toolkit
```
## 配置
在项目中创建 `config.json` 文件：
```json
{
"workspace": {
"rootPath": "/项目路径",
"allowedPaths": ["/允许路径1", "/允许路径2"]
},
"network": {
"proxy": "http://代理服务器:端口" // 可选
},
"database": {
"mysql": {
"host": "localhost",
"port": 3306,
"user": "用户名",
"password": "密码",
"database": "数据库名"
}
// PostgreSQL 和 Redis 的类似配置
}
}
```
## 使用方法
```typescript
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`: 删除仓库
### Web 工具
- `read_webpage`: 提取网页内容
- `brave_search`: 使用 Brave 搜索
- `http_request`: 发送 HTTP 请求
### 系统工具
- `execute_command`: 执行系统命令
- `everything_search`: 本地文件搜索
- `logger`: 日志记录
- `get_stack_trace`: 堆栈跟踪分析
## 安全性
- 可配置的工作空间限制
- 命令执行控制
- 数据库访问管理
- 外部服务的令牌认证
## 参与贡献
欢迎贡献！请阅读我们的[贡献指南](CONTRIBUTING.md)了解详情。
## 许可证
MIT License