tabby-mcp-server

🚀 Tabby-MCP-Server（Tabby-MCP服务器）

Tabby-MCP-Server 是一款强大的 Tabby 插件，它实现了模型上下文协议（MCP）服务器，能够将 AI 助手无缝连接到终端，赋能 AI 终端控制与自动化操作，适用于多种操作系统和环境。

🚀 快速开始

使用示例

const { TabbyMCP } = require('tabby-mcp-server');

// 初始化 MCP 服务
const mcpServer = new TabbyMCP({
    port: 3000, // 自定义端口，默认为 3000
    apiKey: 'your-api-key' // 必填：你的 API 密钥
});

// 启动服务
mcpServer.start();

配置说明

环境变量

• PORT：指定服务运行的端口，默认为 3000。
• API_KEY：必填，用于身份验证的 API 密钥。

✨ 主要特性

• 🤖 AI 连接：无缝连接 AI 助手到终端
• 🔌 MCP 服务器：内置模型上下文协议（MCP）服务器
• 💻 终端控制：赋能终端自动化操作
• 📱 多平台支持：适用于多种操作系统和环境

📦 安装指南

安装步骤

1. 克隆仓库：

   git clone https://github.com/thuanpham582002/tabby-mcp-server.git
   cd tabby-mcp-server
   

2. 安装依赖：

   npm install
   

3. 启动服务器：

   npm start
   

📚 详细文档

功能详解

核心功能

• AI 连接：通过 MCP 协议与 AI 代理交互
• 终端控制：实现对终端设备的自动化操作
• 多平台支持：适用于 Windows、Linux 和 macOS 系统

API 参考

类接口

TabbyMCP 类

构造函数

new TabbyMCP(options: {
    port?: number, // 服务运行的端口，默认为 3000
    apiKey: string // 必填：API 密钥
})

方法

• start(): 启动 MCP 服务器。
• stop(): 停止 MCP 服务器。

贡献指南

参与贡献

1. Fork 仓库
2. 创建功能分支：

   git checkout -b feature/amazing-feature
   

3. 提交更改：

   git commit -m '添加 amazing 功能'
   

4. 推送到分支：

   git push origin feature/amazing-feature
   

5. 提交 Pull Request

详细贡献指南请参考 CONTRIBUTING.md。

持续集成

项目使用 GitHub Actions 实现 CI/CD：

• Pull Requests：自动构建和测试，确保代码质量。
• 主分支：自动发布到 npm 并创建 GitHub 发布版本。

在你的 Fork 中配置以下秘密以启用 CI/CD：

• NPM_TOKEN：npm 访问令牌
• GITHUB_TOKEN：GitHub 自动提供

📄 许可证

本项目遵循 MIT 许可证，具体内容请参阅 LICENSE 文件。

由 ❤️ [Pham Tien Thuan](https://github.com/thuanpham582002) 开发