MCP Toolkit

开发官方认证本地 TypeScript

🚀 MCP 工具包

MCP 工具包是一套全面的模型上下文协议（MCP）服务器实现方案，它提供了丰富多样的工具集。借助该工具包，AI 助手能够与本地系统、文件、数据库以及外部服务进行交互，有效拓展了 AI 在现实世界中的交互能力，同时确保了安全性与可控性。

🚀 快速开始

若要使用 MCP 工具包，首先需进行安装，然后配置相关参数，最后启动服务器。以下为您详细介绍操作步骤：

安装

在命令行中执行以下命令进行安装：

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

✨ 主要特性

MCP 工具包具备多种强大的功能，主要特性如下：

文件系统操作
- 支持读取和写入文件，无论是文本文件还是二进制文件都能轻松处理。
- 可创建和删除目录，灵活管理文件系统结构。
- 能使用正则表达式搜索文件，快速定位所需文件。
- 可列出目录内容，清晰了解目录下的文件和子目录。
- 能够提取代码定义，方便进行代码分析。
数据库集成
- 支持 MySQL、PostgreSQL 和 Redis 等多种数据库。
- 具备事务管理功能，确保数据操作的一致性。
- 支持参数化查询，提高数据库操作的安全性和效率。
GitHub 集成
- 可进行仓库管理，包括创建、更新和删除仓库。
- 支持代码搜索，快速找到所需代码。
- 能进行文件操作，如查看文件内容等。
- 可对仓库结构进行分析，了解仓库的组织架构。
网络能力
- 能够提取网页内容，获取所需信息。
- 集成了 Brave 搜索，提供更强大的搜索功能。
- 可处理 HTTP 请求，方便与外部服务进行交互。
- 支持代理，增强网络访问的灵活性和安全性。
系统工具
- 可执行系统命令，实现对本地系统的控制。
- 集成了 Everything 搜索，快速搜索本地文件。
- 支持栈跟踪分析，帮助调试程序。
- 具备日志记录系统，方便记录和查看系统运行信息。

📚 详细文档

工具详情

文件操作工具

工具名称	功能描述
`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 工具包的贡献！请参考我们的贡献指南了解如何参与开发。

📄 许可证

MCP 工具包遵循 MIT License。

0 条评论
分类：开发