Sandbox Fusion

🚀 Sandbox Fusion MCP Server

This is an implementation of the MCP (Machine Code Protocol) server that integrates with Sandbox Fusion, providing code interpreter functionality for large language models.

🚀 Quick Start

The Sandbox Fusion MCP server is designed to offer code interpreter functionality for large language models. It communicates with clients via stdio and provides a range of APIs for resource access and code execution.

✨ Features

• Supports code execution in multiple programming languages.
• Enables the execution of Jupyter notebooks.
• Communicates with clients through stdio interaction.
• Offers resource and tool APIs for large language models to call.

📦 Installation

Environment Requirements

• Python 3.10+
• Conda (recommended for environment management)

Installation Steps

1. Clone the repository:

git clone https://github.com/happyZYM/sandbox-fusion-mcp.git
cd sandbox-fusion-mcp

2. Create and activate a Conda environment:

conda env create -f environment.yml
conda activate mcp-sandbox-fusion

💻 Configuration

The server is configured through environment variables:

• SANDBOX_FUSION_ENDPOINT: The endpoint address of the Sandbox Fusion API, defaulting to http://localhost:8000.

💻 Usage Examples

Basic Usage

To start the server, you can use the provided startup script:

./launch.sh

Or run the Python script directly:

python server.py

📚 Documentation

API Documentation

Resources

The server provides the following resources:

1. sandbox://languages - Get the list of supported programming languages.
2. sandbox://endpoint - Get the currently configured Sandbox Fusion endpoint information.

Tools

The server provides the following tools:

1. execute_code - Execute a code snippet.
   • Parameters:
     • code (string): The code to be executed.
     • language (string, optional): The programming language, defaulting to "python".
     • timeout (integer, optional): The execution timeout in seconds.
2. execute_jupyter - Execute a Jupyter notebook.
   • Parameters:
     • notebook_content (string): The content of the Jupyter notebook (in JSON format).
     • timeout (integer, optional): The execution timeout in seconds.

Prompt Templates

The server provides the following prompt templates:

1. code_execution_prompt - Code execution prompt template.
   • Parameters:
     • language (string, optional): The programming language, defaulting to "python".
     • description (string, optional): The description of the code task.
2. jupyter_execution_prompt - Jupyter notebook execution prompt template.
   • Parameters:
     • description (string, optional): The description of the notebook task.

Integration with Clients

The MCP server communicates with clients through stdio interaction, and clients can communicate via JSON - RPC.

Example: List available tools

{"jsonrpc": "2.0", "method": "list_tools", "params": {}, "id": 1}

Troubleshooting

If you encounter issues during installation or operation, please check the following:

• Ensure that Python and Conda are installed correctly.
• Check if the environment variables are configured correctly.
• View the log files for more information.

Development Guide

Code Structure

The project directory is as follows:

sandbox-fusion-mcp/
├── server.py          # Main program entry
├── launch.sh         # Startup script
└── environment.yml   # Conda environment configuration file

Contribution Guide

If you want to contribute to this project, please follow these steps:

1. Fork the project repository.
2. Create a feature branch.
3. Submit your code.
4. Push to the remote repository.
5. Create a Pull Request.

Important Notes

• Do not use untested versions directly in a production environment.
• Back up important data before modifying the configuration.
• Ensure the security of API calls.

📄 License

This project is licensed under the MIT License. The full text of the license is as follows:

MIT License

Copyright (c) [Year] [Author's Name]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.