Tabby MCP Server

🚀 Tabby-MCP-Server

A powerful Tabby plugin that implements a Model Context Protocol (MCP) server, enabling AI terminal control and automation.

📹 Video Demo

Watch the full video demonstration of Tabby-MCP features:

✨ Features

• 🤖 AI Connectivity: Seamlessly connect AI assistants to the terminal.
• 🔌 MCP Server: Built-in Model Context Protocol (MCP) server.
• 💻 Terminal Control: Empower terminal automation operations.
• 📱 Multi-platform Support: Compatible with various operating systems and environments.

📦 Installation

Installation Steps

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Start the server:

   npm start
   

🚀 Quick Start

💻 Usage Examples

Basic Usage

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

// Initialize the MCP service
const mcpServer = new TabbyMCP({
    port: 3000, // Custom port, default is 3000
    apiKey: 'your-api-key' // Required: Your API key
});

// Start the service
mcpServer.start();

Configuration Instructions

Environment Variables

• PORT: Specify the port on which the service runs, default is 3000.
• API_KEY: Required, the API key for authentication.

📚 Documentation

Core Functions

• AI Connectivity: Interact with AI agents through the MCP protocol.
• Terminal Control: Automate operations on terminal devices.
• Multi-platform Support: Compatible with Windows, Linux, and macOS systems.

📄 API Reference

Class Interfaces

TabbyMCP Class

Constructor

new TabbyMCP(options: {
    port?: number, // The port on which the service runs, default is 3000
    apiKey: string // Required: API key
})

Methods

• start(): Start the MCP server.
• stop(): Stop the MCP server.

🤝 Contribution Guidelines

Contribute to the Project

1. Fork the repository.
2. Create a feature branch:

   git checkout -b feature/amazing-feature
   

3. Commit your changes:

   git commit -m 'Add amazing feature'
   

4. Push to the branch:

   git push origin feature/amazing-feature
   

5. Submit a Pull Request.

Refer to CONTRIBUTING.md for detailed contribution guidelines.

Continuous Integration

The project uses GitHub Actions for CI/CD:

• Pull Requests: Automatically build and test to ensure code quality.
• Main Branch: Automatically publish to npm and create a GitHub release.

Configure the following secrets in your fork to enable CI/CD:

• NPM_TOKEN: npm access token
• GITHUB_TOKEN: Automatically provided by GitHub

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

Developed with ❤️ by [Pham Tien Thuan](https://github.com/thuanpham582002)