read_workflow — 读取工作流 YAML

`read_workflow` — 读取工作流 YAML

读取一个工作流草稿、版本和时间戳。

适用于稳定版 Viat 1.1.0。先阅读 MCP 配置与结果处理。以下为合成的、从源码推导的预期形状，不是已执行的响应。编写本页没有访问服务、提供方或设备。

前提与权限

需要所选项目的成员身份（任意项目角色，包括 Viewer）。平台角色不等同于项目成员身份。PAT 必须有效且其范围允许访问该路由。

使用已激活的隔离实例，配置服务器和 bearer；除 list_projects 外须有 mcp-lab 项目。示例中的现有资产和 ID 以概览夹具为前提，用夹具实际返回 ID 替换合成 ID；示例不会自行创建依赖。

完整输入字段

必填表示导出输入合约的结构要求，不等于完整条件 API 验证。可选字段的显式 JSON null 与省略同样反序列化，包括未限定类型的 JSON 字段。空字符串、数组或对象是实际值，不是省略。数值 format 表示序列化边界，运行时限制和默认值另算。args 的模式 default:null 不等于其运行时默认 {}。

字段	类型	必填	省略 / 显式 null	约束和含义
`folder`	string / null	否（可能条件必填）	不向 API 提供，条件规则见下文。；null 等同省略。	资源、脚本或工作流文件夹路径，空字符串选根目录，省略或 null 使用名称查找。非空路径最多 255 字节、8 层，各段为 [A-Za-z0-9_-]+，不能有开头、末尾或重复斜杠。
`name`	string	是	无默认值，缺失或 null 无效。	精确资产名；身份与文件夹规则见本页说明。
`project`	string / null	否（可能条件必填）	VIAT_PROJECT / current_project；否则 project_required；null 等同省略。	项目 slug；省略或 null 使用 VIAT_PROJECT/current_project，否则 project_required。

行为与验证

可选 folder 作为查询参数转发。请使用 list_workflows 返回的文件夹；空字符串显式选择根目录。定义返回文本，而非解析后的步骤对象。

输出与分页

工作流对象包含字符串 name、definition（YAML 文本）、created_at、updated_at，整数 version，以及可选字符串 folder（根目录省略）。

无分页或续页游标。

值会序列化成 JSON，放进一个 MCP content 文本块。请把 result.content[0].text 解析为 JSON。不承诺 structuredContent 或 outputSchema；注明省略的可选字段不能假定以 null 存在。

合成请求与预期形状

完成 MCP initialize/initialized 后，通过 stdio 以单行 JSON 发送此 tools/call 请求（此处格式化仅为便于阅读）。

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "read_workflow",
    "arguments": {
      "project": "mcp-lab",
      "name": "mcp_flow",
      "folder": ""
    }
  }
}

预期 MCP 外层形状（ID、时间戳、头和计算值均为示意，不是确定值断言）。

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"name\":\"mcp_flow\",\"version\":1,\"definition\":\"inputs:\\nsteps:\\n  - id: hello\\n    script: mcp_demo\\n    args: {}\\noutputs:\\n  result: \\\"$hello.output\\\"\\n\",\"created_at\":\"2026-01-01T00:00:00Z\",\"updated_at\":\"2026-01-01T00:00:00Z\"}"
      }
    ],
    "isError": false
  }
}

文本块内解码后的 JSON 值：

{
  "name": "mcp_flow",
  "version": 1,
  "definition": "inputs:\nsteps:\n  - id: hello\n    script: mcp_demo\n    args: {}\noutputs:\n  result: \"$hello.output\"\n",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z"
}

失败与恢复

不存在时返回 404；歧义裸名称可能返回 409。读取不会验证所有引用的脚本和资源一定能成功运行。

所有上游工具都可能因令牌过期或撤销、PAT 范围、项目权限、激活、网络或超时失败。无项目及默认值时为 project_required；控制面非 2xx 为 http_4xx/http_5xx。详见公共错误外层及重试规则。输入反序列化或未知工具可能在进入工具层前成为 JSON-RPC 协议错误，不要假定每个失败都有 isError。retryable 标志不保证幂等。

副作用、验证与清理

只读：不修改资产，无需清理。请保护返回的源码、日志和标识符。

验证应以观察为主：检查本文结果字段，获准修改前后使用对应读取工具。不要通过生产请求或删除无关对象来验证。

维护依据

输入清单：contracts/1.1.0/mcp-tools.json，工具 read_workflow. 固定产品源码中的实现和测试： workflows.rs; handlers/workflows.rs; tests/it/tool_read_workflow.rs. 工具模块文件名相对 crates/viat-mcp/src/tools/，API handler 相对 crates/viat-api/src/handlers/。公共传输和错误依据为 crates/viat-mcp/src/tools/service.rs、http.rs、error.rs；本次仅阅读测试，没有运行测试。