Cloud Studio MCP Server
Project description
Cloud Studio MCP 部署服务
Cloud Studio MCP 部署服务是一个基于FastMCP的服务器,提供Cloud Studio工作空间的管理功能,包括创建工作空间、上传文件和执行命令等操作。
功能特性
- 创建工作空间:创建新的Cloud Studio工作空间实例
- 文件管理:上传文件到指定工作空间
- 命令执行:在工作空间中执行shell命令
- MCP集成:通过MCP协议提供标准化接口
安装指南
前置要求
- Python 3.8+
- API_TOKEN环境变量(Cloud Studio API访问令牌)
安装步骤
-
克隆仓库:
git clone <repository-url> cd mcp_deploy
-
创建并激活虚拟环境:
python -m venv .venv source .venv/bin/activate # Linux/macOS .\.venv\Scripts\activate # Windows
-
安装依赖:
pip install -e .
配置说明
在运行服务前,需要设置以下环境变量:
export API_TOKEN="your_cloud_studio_api_token"
export region="ap-shanghai" # 可选,默认为ap-shanghai
使用说明
启动服务
python -m mcp_deploy
API 文档
服务提供以下MCP工具:
1. 创建工作空间
create_workspace(title str) -> dict
返回示例:
{
"space_key": "kmhhvqnlogr48",
"webIDE": "https://kmhhv1pyvc48--ide.ap-shanghai.cloudstudio.club"
}
2. 上传文件
write_files(space_key: str, region: str, files: list[File]) -> str
文件格式:
class File:
save_path: str # 文件保存路径
file_content: str # 文件内容(UTF-8编码)
3. 执行命令
execute_command(space_key: str, region: str, command: str) -> str
示例:
execute_command("xxxx", "ap-shanghai", "ls -al")
开发指南
项目结构
mcp_deploy/
├── __init__.py
├── __main__.py
├── mcp_handlers.py # 核心业务逻辑
├── models.py # 数据模型定义
└── server.py # FastMCP服务器实现
测试
- 确保已设置API_TOKEN环境变量
- 运行测试命令:
python -m pytest
贡献
欢迎提交Pull Request或Issue报告问题。
许可证
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cloudstudio_mcp_server-1.0.7.tar.gz.
File metadata
- Download URL: cloudstudio_mcp_server-1.0.7.tar.gz
- Upload date:
- Size: 57.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0ceeac7f9f22e7883c4d6fe9065046c755f2bbc9226610841be8a4adb0ebb210
|
|
| MD5 |
4b9042e5697e9f68f39f9f9426eb32f0
|
|
| BLAKE2b-256 |
07705d88b03dc53a90ad219218a658d09f5034aa9822f3d28824342150ec96c9
|
File details
Details for the file cloudstudio_mcp_server-1.0.7-py3-none-any.whl.
File metadata
- Download URL: cloudstudio_mcp_server-1.0.7-py3-none-any.whl
- Upload date:
- Size: 16.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
459ea446b1c12b386508d9cf3c814525b506f10bc5f1937e2663596a71b185cf
|
|
| MD5 |
5ac61afe2b29c9a0c40a680d4fdf08ba
|
|
| BLAKE2b-256 |
6caf575018e710f6d81a055ff1af33a2d4dd6a7f3ee9225d76a8888c2453d42b
|