AI agents call yuandian_get_api_document to retrieve information from Yuandian without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | — | 接口 ID |
routeKey | string | — | 接口 routeKey |
toolName | string | — | MCP tool 名称，例如 yuandian_rh_enterpriseSearch |
Parameters from the server's own tool schema.
This tool retrieves and returns API documentation based on provided identifiers. It is a pure read operation with no side effects, no data modification, no code execution, and no financial impact. The worst-case misuse would be unauthorized access to documentation, which has minimal blast radius.
From the tool's definition Tool name 'yuandian_get_api_document' and description '根据接口 id、routeKey 或 MCP toolName 获取元典开放平台 Markdown 接口文档' (retrieve YuanDian open platform Markdown API documentation by interface id, routeKey, or MCP toolName) indicates a retrieval/query operation that…
Attacks that exploit this kind of access
根据接口 id、routeKey 或 MCP toolName 获取元典开放平台 Markdown 接口文档。. It is categorised as a Read tool in the Yuandian MCP Server, which means it retrieves data without modifying state.
yuandian_get_api_document accepts 3 parameters: id, routeKey, toolName. The full parameter table on this page comes from the server's own tool schema.
Register the Yuandian MCP server in PolicyLayer and add a rule for yuandian_get_api_document: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Yuandian. Nothing to install.
yuandian_get_api_document is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the yuandian_get_api_document rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.
Set action: deny in the PolicyLayer policy for yuandian_get_api_document. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.
yuandian_get_api_document is provided by the Yuandian MCP server (yuandian-mcp-server). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
Every MCP server has a record like this.
Type a name, get the same breakdown: verified identity, auth posture, risk grade, capabilities, recommended policy.
Teams ship this data inside their own products. See what a licence covers →