跳转到内容

read_script — 读取单个脚本

读取草稿源码、语言及推导的输入输出模式。

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

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

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

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

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

请求 GET /projects/{slug}/scripts/{name},可附带 folder 查询参数。裸名称优先匹配根目录副本;无根副本且多个文件夹中有同名项时返回 409。folder:"" 显式选择根目录。

脚本对象:name、language、content、created_at、updated_at 为字符串,version 为整数,is_system 为布尔值。根目录省略 folder。input_schema、output_schema、schema_warnings 为 JSON 值,上游为 null 或缺失时省略。

无分页或续页游标。

值会序列化成 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_script",
"arguments": {
"project": "mcp-lab",
"name": "mcp_demo",
"folder": ""
}
}
}

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

{
"jsonrpc": "2.0",
"id": 3,
"result": {
"content": [
{
"type": "text",
"text": "{\"name\":\"mcp_demo\",\"language\":\"python\",\"content\":\"def main():\\n return {\\\"ok\\\": True}\\n\",\"version\":1,\"is_system\":false,\"created_at\":\"2026-01-01T00:00:00Z\",\"updated_at\":\"2026-01-01T00:00:00Z\"}"
}
],
"isError": false
}
}

文本块内解码后的 JSON 值:

{
"name": "mcp_demo",
"language": "python",
"content": "def main():\n return {\"ok\": True}\n",
"version": 1,
"is_system": false,
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}

409 会要求提供 folder,但不会列出候选文件夹(与输入描述的说法不同);请先使用 list_scripts。404 表示没有匹配脚本。模式可以缺失,缺失不等于空模式。

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

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

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

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