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) 開發