Sillytavern MCP Extension

🚀 SillyTavern MCP Extension

This extension adds WebSocket-based tool execution support to SillyTavern, allowing external tools to be registered and run through a unified interface.

✨ Features

• Real-time communication via WebSocket server
• Tool registration and execution system
• JSON Schema validation for tool definitions
• Real-time execution status updates
• Configurable logging and WebSocket settings
• Integration into SillyTavern's web-based settings interface

📦 Installation

Method 1: Web Interface Installation (Recommended)

Please refer to INSTRUCTIONS.md for installation via SillyTavern's web interface.

Method 2: Manual Installation

1. Clone the repository to your local machine:

git clone https://github.com/CG-Labs/SillyTavern-MCP-Extension.git

2. Navigate to the project directory and install dependencies:

cd SillyTavern-MCP-Extension
npm install

🛠️ Configuration

The following options can be configured through SillyTavern's UI settings:

• WebSocket Port: Default is 3000
• Log Level: Supports four levels: debug, info, warn, error

💻 Usage Examples

Tool Registration

Send the following JSON-formatted message to the WebSocket server:

{
    "type": "register_tool",
    "data": {
        "name": "tool_name",
        "schema": {
            // Define the JSON Schema for tool parameters
        }
    }
}

Tool Execution

Send a message in the following format to execute a tool:

{
    "type": "execute_tool",
    "data": {
        "executionId": "unique_id",
        "toolName": "tool_name",
        "args": {
            // Execution parameters
        }
    }
}

Execution Status Update

Receive a message in the following format to get the execution status:

{
    "type": "tool_execution_status",
    "data": {
        "executionId": "unique_id",
        "status": "running|success|failed",
        "message": "Status information"
    }
}

❌ Error Codes

• ERROR_100: Tool not registered
• ERROR_101: Invalid parameters
• ERROR_102: Execution timeout
• ERROR_103: Internal server error

📁 Project Structure

SillyTavern-MCP-Extension/
├── index.js          # Main plugin entry
├── config.js        # Configuration management
├── tools/           # Tool registration and management
│   └── tool1.js    # Example tool implementation
└── package.json     # Project dependency management

🛠️ Development Guide

Adding a New Tool

Add a new tool to the tools/ directory and define its behavior:

// example_tool.js
module.exports = {
    name: 'example_tool',
    schema: {
        type: 'object',
        properties: {
            input: { type: 'string' }
        },
        required: ['input']
    },
    execute: function(args) {
        // Execution logic
        return result;
    }
};

🤝 Contribution Guide

1. Fork the repository to your personal account.
2. Create a feature branch.
3. Commit your code changes.
4. Push to the branch.
5. Submit a Pull Request.

🆘 Support

If you encounter any issues or have questions:

1. Check GitHub Issues for known issues.
2. If the issue is not found, create a new Issue.
3. Join the SillyTavern Discord community for help.

📄 License

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