Mcpstudio

🚀 MCPStudio：模型上下文协议的邮差平台

MCPStudio 是一款强大且易用的平台，专注于创建、测试、管理和发现模型上下文协议（MCP）服务器。如同 Postman 革新 API 开发和测试方式一样，MCPStudio 借助直观的可视化界面与 MCP 服务器交互，简化了底层技术的复杂性。

🚀 快速开始

安装步骤

1. 克隆仓库：

   git clone https://github.com/lonexreb/mcpstudio.git
   cd mcpstudio
   

2. 设置后端：

   cd backend/mcp_studio_backend
   python -m venv venv
   source venv/bin/activate  # Windows: venv\Scripts\activate
   pip install uv
   uv pip install -e .
   

3. 设置前端：

   cd frontend/ai-server-forge
   npm install
   

4. 启动开发服务器

   • 后端：

     cd backend/mcp_studio_backend
     uvicorn mcp_studio.main:app --reload
     

   • 前端：

     cd frontend/ai-server-forge
     npm run dev
     

5. 打开浏览器，访问 http://localhost:3000

工作流程

1. 用户通过界⾯创建 MCP 服务器。
2. 平台向服务器发送连接请求。
3. 成功连接后，用户可以查看和管理服务器上的工具。
4. 执行工具操作时，平台接收并展示结果。

✨ 主要特性

服务器管理

• 可创建、列出、更新和删除 MCP 服务器。
• 支持连接和断开与服务器的连接。

工具管理

• 能列出特定服务器的所有可用工具。
• 可执行指定工具的操作。

认证

• 采用 JWT 基础认证。
• 支持 Google OAuth 登录。

📦 安装指南

后端安装

1. 初始化环境：

   python -m venv venv
   source venv/bin/activate  # Windows: venv\Scripts\activate
   pip install uv
   uv pip install -e .
   

2. 配置文件路径：

   mcpstudio/
   ├── backend/
   │   └── mcp_studio/
   │       ├── config.py
   │       └── main.py
   └── frontend/
       └── ai-server-forge/
           └── package.json
   

前端安装

在前端目录下执行 npm install 进行依赖安装。

💻 使用示例

后端初始化环境示例

python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install uv
uv pip install -e .

提交代码示例

git checkout main
git pull origin main
git checkout feature/my-feature
# 开发...
git add .
git commit -m "feat: 添加新功能"
git push origin feature/my-feature

📚 详细文档

什么是模型上下文协议 (MCP)?

模型上下文协议是一项标准，使 AI 系统（如大型语言模型）能够无缝连接到外部工具、服务或其他系统。MCP 定义了 AI 代理与其环境之间的接口，使得这些代理能够执行操作并获取结果。

核心架构

后端

前端

API 端点

服务器管理

• POST /api/servers - 创建新服务器
• GET /api/servers - 列出所有服务器
• GET /api/servers/{server_id} - 获取服务器详情
• PUT /api/servers/{server_id} - 更新服务器
• DELETE /api/servers/{server_id} - 删除服务器
• POST /api/servers/{server_id}/connect - 连接服务器
• POST /api/servers/{server_id}/disconnect - 断开连接

工具管理

• GET /api/servers/{server_id}/tools - 列出服务器上的工具
• GET /api/tools/{tool_id} - 获取工具详情
• POST /api/servers/{server_id}/tools/{tool_id}/execute - 执行工具操作

认证

• POST /api/auth/token - 获取 JWT 访问令牌
• GET /api/auth/google/auth - 获取 Google OAuth 链接
• GET /api/auth/google/callback - 处理 Google OAuth 回调
• GET /api/auth/user - 获取当前用户信息

贡献指南

1. 提交代码时，请遵循 Git 工作流：

   git checkout main
   git pull origin main
   git checkout feature/my-feature
   # 开发...
   git add .
   git commit -m "feat: 添加新功能"
   git push origin feature/my-feature
   

2. 提交 Pull Request 前，请确保代码通过所有测试。

🔧 技术细节

后端

• 框架：FastAPI
• 语言：Python
• 依赖管理：UV
• 配置：
  • 端口：8000
  • 文档：/docs

前端

• 框架：React
• 状态管理：Redux
• 样式：Tailwind CSS
• 构建工具：Webpack

📄 许可证

本项目遵循 MIT 协议。请查看 LICENSE 文件以获取详细信息。

📞 联系方式

如有任何问题或建议，请联系：

• 邮箱：contact@example.com
• GitHub：https://github.com/lonexreb/mcpstudio