mirror of
https://github.com/simstudioai/sim.git
synced 2026-04-28 03:00:29 -04:00
feat(i18n): update translations (#2645)
Co-authored-by: waleedlatif1 <waleedlatif1@users.noreply.github.com>
This commit is contained in:
107
apps/docs/content/docs/zh/mcp/deploy-workflows.mdx
Normal file
107
apps/docs/content/docs/zh/mcp/deploy-workflows.mdx
Normal file
@@ -0,0 +1,107 @@
|
||||
---
|
||||
title: 将工作流部署为 MCP
|
||||
description: 将您的工作流公开为 MCP 工具,供外部 AI 助手和应用程序使用
|
||||
---
|
||||
|
||||
import { Video } from '@/components/ui/video'
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
|
||||
将您的工作流部署为 MCP 工具,使其可供外部 AI 助手(如 Claude Desktop、Cursor 以及其他兼容 MCP 的客户端)访问。这会让您的工作流变成可随时调用的工具。
|
||||
|
||||
## 创建和管理 MCP 服务器
|
||||
|
||||
MCP 服务器用于将您的工作流工具进行分组。您可以在工作区设置中创建和管理这些服务器:
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<Video src="mcp/mcp-server.mp4" width={700} height={450} />
|
||||
</div>
|
||||
|
||||
1. 进入 **设置 → MCP 服务器**
|
||||
2. 点击 **创建服务器**
|
||||
3. 输入名称和可选描述
|
||||
4. 复制服务器 URL 以在您的 MCP 客户端中使用
|
||||
5. 查看并管理已添加到服务器的所有工具
|
||||
|
||||
## 添加工作流为工具
|
||||
|
||||
当您的工作流部署完成后,可以将其公开为 MCP 工具:
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<Video src="mcp/mcp-deploy-tool.mp4" width={700} height={450} />
|
||||
</div>
|
||||
|
||||
1. 打开已部署的工作流
|
||||
2. 点击 **部署** 并进入 **MCP** 标签页
|
||||
3. 配置工具名称和描述
|
||||
4. 为每个参数添加描述(帮助 AI 理解输入)
|
||||
5. 选择要添加到的 MCP 服务器
|
||||
|
||||
<Callout type="info">
|
||||
工作流必须先部署,才能添加为 MCP 工具。
|
||||
</Callout>
|
||||
|
||||
## 工具配置
|
||||
|
||||
### 工具名称
|
||||
请使用小写字母、数字和下划线。名称应具有描述性,并遵循 MCP 命名规范(如 `search_documents`、`send_email`)。
|
||||
|
||||
### 描述
|
||||
请清晰描述该工具的功能。这有助于 AI 助手理解何时使用该工具。
|
||||
|
||||
### 参数
|
||||
您的工作流输入格式字段会变成工具参数。为每个参数添加描述,有助于 AI 助手提供正确的值。
|
||||
|
||||
## 连接 MCP 客户端
|
||||
|
||||
使用设置中的服务器 URL 连接外部应用程序:
|
||||
|
||||
### Claude Desktop
|
||||
将以下内容添加到您的 Claude Desktop 配置中(`~/Library/Application Support/Claude/claude_desktop_config.json`):
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"my-sim-workflows": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "mcp-remote", "YOUR_SERVER_URL"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Cursor
|
||||
在 Cursor 的 MCP 设置中,使用相同的 mcp-remote 格式添加服务器 URL。
|
||||
|
||||
<Callout type="warn">
|
||||
使用 mcp-remote 或其他基于 HTTP 的 MCP 传输方式时,请包含 API key header(`X-API-Key`)以进行身份验证访问。
|
||||
</Callout>
|
||||
|
||||
## 服务器管理
|
||||
|
||||
在 **设置 → MCP 服务器** 的服务器详情视图中,您可以:
|
||||
|
||||
- **查看工具**:查看添加到服务器的所有工作流
|
||||
- **复制 URL**:获取 MCP 客户端的服务器 URL
|
||||
- **添加工作流**:将更多已部署的工作流添加为工具
|
||||
- **移除工具**:从服务器中移除工作流
|
||||
- **删除服务器**:移除整个服务器及其所有工具
|
||||
|
||||
## 工作原理
|
||||
|
||||
当 MCP 客户端调用您的工具时:
|
||||
|
||||
1. 请求会发送到您的 MCP 服务器 URL
|
||||
2. Sim 验证请求并将参数映射到工作流输入
|
||||
3. 已部署的工作流会使用提供的输入执行
|
||||
4. 结果返回给 MCP 客户端
|
||||
|
||||
工作流执行时使用与 API 调用相同的部署版本,确保行为一致。
|
||||
|
||||
## 权限要求
|
||||
|
||||
| 操作 | 所需权限 |
|
||||
|--------|-------------------|
|
||||
| 创建 MCP 服务器 | **Admin** |
|
||||
| 向服务器添加工作流 | **Write** 或 **Admin** |
|
||||
| 查看 MCP 服务器 | **Read**、**Write** 或 **Admin** |
|
||||
| 删除 MCP 服务器 | **Admin** |
|
||||
@@ -1,8 +1,10 @@
|
||||
---
|
||||
title: MCP(模型上下文协议)
|
||||
title: 使用 MCP 工具
|
||||
description: 通过 Model Context Protocol 连接外部工具和服务
|
||||
---
|
||||
|
||||
import { Image } from '@/components/ui/image'
|
||||
import { Video } from '@/components/ui/video'
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
|
||||
模型上下文协议([MCP](https://modelcontextprotocol.com/))允许您使用标准化协议连接外部工具和服务,从而将 API 和服务直接集成到您的工作流程中。通过 MCP,您可以通过添加自定义集成来扩展 Sim 的功能,使其与您的代理和工作流程无缝协作。
|
||||
@@ -20,14 +22,8 @@ MCP 是一项开放标准,使 AI 助手能够安全地连接到外部数据源
|
||||
|
||||
MCP 服务器提供工具集合,供您的代理使用。您可以在工作区设置中进行配置:
|
||||
|
||||
<div className="flex justify-center">
|
||||
<Image
|
||||
src="/static/blocks/mcp-1.png"
|
||||
alt="在设置中配置 MCP 服务器"
|
||||
width={700}
|
||||
height={450}
|
||||
className="my-6"
|
||||
/>
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<Video src="mcp/settings-mcp-tools.mp4" width={700} height={450} />
|
||||
</div>
|
||||
|
||||
1. 进入您的工作区设置
|
||||
@@ -40,56 +36,60 @@ MCP 服务器提供工具集合,供您的代理使用。您可以在工作区
|
||||
您还可以直接从代理模块的工具栏中配置 MCP 服务器,以便快速设置。
|
||||
</Callout>
|
||||
|
||||
## 在代理中使用 MCP 工具
|
||||
### 刷新工具
|
||||
|
||||
一旦配置了 MCP 服务器,其工具将在您的代理模块中可用:
|
||||
点击服务器上的 **刷新**,即可获取最新的工具 schema,并自动用新的参数定义更新所有使用这些工具的 agent 模块。
|
||||
|
||||
## 在 Agent 中使用 MCP 工具
|
||||
|
||||
配置好 MCP 服务器后,其工具会在你的 agent 模块中可用:
|
||||
|
||||
<div className="flex justify-center">
|
||||
<Image
|
||||
src="/static/blocks/mcp-2.png"
|
||||
alt="在代理模块中使用 MCP 工具"
|
||||
alt="在 Agent 模块中使用 MCP 工具"
|
||||
width={700}
|
||||
height={450}
|
||||
className="my-6"
|
||||
/>
|
||||
</div>
|
||||
|
||||
1. 打开一个 **代理** 模块
|
||||
2. 在 **工具** 部分,您将看到可用的 MCP 工具
|
||||
3. 选择您希望代理使用的工具
|
||||
4. 代理现在可以在执行过程中访问这些工具
|
||||
1. 打开一个 **Agent** 模块
|
||||
2. 在 **工具** 部分,你会看到可用的 MCP 工具
|
||||
3. 选择你希望 agent 使用的工具
|
||||
4. agent 在执行时即可访问这些工具
|
||||
|
||||
## 独立的 MCP 工具模块
|
||||
## 独立 MCP 工具模块
|
||||
|
||||
为了更精细的控制,您可以使用专用的 MCP 工具模块来执行特定的 MCP 工具:
|
||||
如需更细致的控制,可以使用专用的 MCP 工具模块来执行特定的 MCP 工具:
|
||||
|
||||
<div className="flex justify-center">
|
||||
<Image
|
||||
src="/static/blocks/mcp-3.png"
|
||||
alt="独立的 MCP 工具模块"
|
||||
alt="独立 MCP 工具模块"
|
||||
width={700}
|
||||
height={450}
|
||||
className="my-6"
|
||||
/>
|
||||
</div>
|
||||
|
||||
MCP 工具模块允许您:
|
||||
- 直接执行任何已配置的 MCP 工具
|
||||
MCP 工具模块可以让你:
|
||||
- 直接执行任意已配置的 MCP 工具
|
||||
- 向工具传递特定参数
|
||||
- 在后续工作流步骤中使用工具的输出
|
||||
- 将多个 MCP 工具串联在一起
|
||||
- 在后续工作流步骤中使用工具输出
|
||||
- 串联多个 MCP 工具
|
||||
|
||||
### 何时使用 MCP 工具与代理
|
||||
### 何时使用 MCP 工具模块与 Agent
|
||||
|
||||
**在以下情况下使用带有 MCP 工具的代理:**
|
||||
- 您希望 AI 决定使用哪些工具
|
||||
- 您需要复杂的推理来决定何时以及如何使用工具
|
||||
- 您希望与工具进行自然语言交互
|
||||
**当你需要以下场景时,使用 Agent 搭配 MCP 工具:**
|
||||
- 希望 AI 决定使用哪些工具
|
||||
- 需要复杂推理来判断何时及如何使用工具
|
||||
- 希望通过自然语言与工具交互
|
||||
|
||||
**在以下情况下使用 MCP 工具块:**
|
||||
- 您需要确定性的工具执行
|
||||
- 您希望使用已知参数执行特定工具
|
||||
- 您正在构建具有可预测步骤的结构化工作流
|
||||
- 你需要确定性的工具执行
|
||||
- 你想用已知参数执行特定工具
|
||||
- 你正在构建具有可预测步骤的结构化工作流
|
||||
|
||||
## 权限要求
|
||||
|
||||
@@ -97,48 +97,48 @@ MCP 功能需要特定的工作区权限:
|
||||
|
||||
| 操作 | 所需权限 |
|
||||
|--------|-------------------|
|
||||
| 在设置中配置 MCP 服务器 | **管理员** |
|
||||
| 在代理中使用 MCP 工具 | **写入** 或 **管理员** |
|
||||
| 查看可用的 MCP 工具 | **读取**、**写入** 或 **管理员** |
|
||||
| 执行 MCP 工具块 | **写入** 或 **管理员** |
|
||||
| 在设置中配置 MCP 服务器 | **Admin** |
|
||||
| 在代理中使用 MCP 工具 | **Write** 或 **Admin** |
|
||||
| 查看可用的 MCP 工具 | **Read**、**Write** 或 **Admin** |
|
||||
| 执行 MCP 工具块 | **Write** 或 **Admin** |
|
||||
|
||||
## 常见使用场景
|
||||
## 常见用例
|
||||
|
||||
### 数据库集成
|
||||
连接到数据库以在工作流中查询、插入或更新数据。
|
||||
在你的工作流中连接数据库以查询、插入或更新数据。
|
||||
|
||||
### API 集成
|
||||
访问没有内置 Sim 集成的外部 API 和 Web 服务。
|
||||
|
||||
### 文件系统访问
|
||||
读取、写入和操作本地或远程文件系统上的文件。
|
||||
在本地或远程文件系统上读取、写入和操作文件。
|
||||
|
||||
### 自定义业务逻辑
|
||||
执行特定于您组织需求的自定义脚本或工具。
|
||||
执行针对你组织需求的自定义脚本或工具。
|
||||
|
||||
### 实时数据访问
|
||||
在工作流执行期间从外部系统获取实时数据。
|
||||
|
||||
## 安全注意事项
|
||||
|
||||
- MCP 服务器以配置它的用户权限运行
|
||||
- 安装前始终验证 MCP 服务器来源
|
||||
- 对于敏感的配置数据,请使用环境变量
|
||||
- 在授予代理访问权限之前,审查 MCP 服务器功能
|
||||
- MCP 服务器以配置它们的用户权限运行
|
||||
- 安装前务必验证 MCP 服务器来源
|
||||
- 对敏感配置信息使用环境变量
|
||||
- 在授予代理访问权限前,审查 MCP 服务器的功能
|
||||
|
||||
## 故障排除
|
||||
## 故障排查
|
||||
|
||||
### MCP 服务器未显示
|
||||
- 验证服务器配置是否正确
|
||||
- 检查您是否具有所需权限
|
||||
- 检查你是否拥有所需权限
|
||||
- 确保 MCP 服务器正在运行且可访问
|
||||
|
||||
### 工具执行失败
|
||||
- 验证工具参数格式是否正确
|
||||
- 检查 MCP 服务器日志中的错误消息
|
||||
- 检查 MCP 服务器日志中的错误信息
|
||||
- 确保已配置所需的身份验证
|
||||
|
||||
### 权限错误
|
||||
- 确认您的工作区权限级别
|
||||
- 检查 MCP 服务器是否需要额外的身份验证
|
||||
- 验证服务器是否已为您的工作区正确配置
|
||||
- 确认你的工作区权限级别
|
||||
- 检查 MCP 服务器是否需要额外认证
|
||||
- 验证服务器是否已为你的工作区正确配置
|
||||
Reference in New Issue
Block a user