跳转到内容

get_endpoint_tree — 读取嵌套端点树

get_endpoint_tree — 读取嵌套端点树

Section titled “get_endpoint_tree — 读取嵌套端点树”

了解一棵指定名称树的 URL 层级。

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

需要编辑权限:项目 Owner、Admin 或 Developer;Viewer 被拒绝。PAT 所有者须具有该项目角色,且 PAT 范围允许访问该路由。

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

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

字段类型必填省略 / 显式 null约束和含义
projectstring / null否(可能条件必填)VIAT_PROJECT / current_project;否则 project_required;null 等同省略。项目 slug;省略或 null 使用 VIAT_PROJECT/current_project,否则 project_required。
treestring是无默认值,缺失或 null 无效。树名称,会解析为 UUID,不是 ID。

必填 tree 通过树集合按精确名称解析,然后按父节点 ID 组装层级。不会创建缺失的树,也不会仅筛选已发布叶节点。

返回 {tree:string,tree_id:string,path_override:string,nodes:Node[]}。每个节点含字符串 id、segment、kind、path,children:Node[],可选字符串 method、script_name、workflow_name,以及可选字符串映射 ws_routes。节点可选字段省略,与 list_endpoints 的 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": "get_endpoint_tree",
"arguments": {
"project": "mcp-lab",
"tree": "main"
}
}
}

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

{
"jsonrpc": "2.0",
"id": 3,
"result": {
"content": [
{
"type": "text",
"text": "{\"tree\":\"main\",\"tree_id\":\"00000000-0000-4000-8000-000000000001\",\"path_override\":\"\",\"nodes\":[{\"id\":\"00000000-0000-4000-8000-000000000001\",\"segment\":\"mcp-demo\",\"method\":\"GET\",\"script_name\":\"mcp_demo\",\"kind\":\"script\",\"path\":\"/mcp-demo\",\"children\":[]}]}"
}
],
"isError": false
}
}

文本块内解码后的 JSON 值:

{
"tree": "main",
"tree_id": "00000000-0000-4000-8000-000000000001",
"path_override": "",
"nodes": [
{
"id": "00000000-0000-4000-8000-000000000001",
"segment": "mcp-demo",
"method": "GET",
"script_name": "mcp_demo",
"kind": "script",
"path": "/mcp-demo",
"children": []
}
]
}

未知树返回 bad_input;读取仍需 Editor。把 UUID 当名称传入不会选中对应树,除非其名称恰好就是该字符串。

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

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

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

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