Tabby MCP Server

🚀 Tabby-MCP-Server（Tabby-MCPサーバー）

強力なTabbyプラグインで、モデルコンテキストプロトコル（MCP）サーバーを実現し、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
   

💻 使用例

基本的な使用法

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

// MCPサービスを初期化する
const mcpServer = new TabbyMCP({
    port: 3000, // カスタムポート、デフォルトは3000
    apiKey: 'your-api-key' // 必須：あなたのAPIキー
});

// サービスを起動する
mcpServer.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)