Retrieves the JSON DSL and summary statistics for a board resource from a Yuque document.
Get board resource JSON DSL and summary stats from a document. GET /yfm/boards. 详见 references/api/board_api.md
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Document URL (mutually exclusive with doc_id) | |
| doc_id | No | Document ID (mutually exclusive with url) | |
| resource_id | Yes | Board resource ID (required, extract the ID part from board://<resource_id>) |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must fully disclose behavior. It indicates a read operation via 'Get' and mentions returning JSON DSL and summary stats, but omits permissions, side effects, error handling, and other behavioral traits. The endpoint and reference are useful but insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences plus a doc reference; the purpose is front-loaded. The reference to a local file may be opaque but doesn't waste much space.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a retrieval tool with no output schema and no annotations, the description should explain what the JSON DSL and summary stats contain, the format, and any prerequisites. It only gives a high-level phrase and a file reference, leaving significant gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all three parameters are documented in the schema. The description adds no parameter-level detail, which is acceptable given the schema's completeness, but it doesn't enhance semantic understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Get) and resource (board resource JSON DSL and summary stats) scoped to a document, and distinguishes from create/update board siblings. The term 'board' is not defined, and the relation to other document retrieval tools is implied rather than explicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit when-to-use guidance, prerequisites, or alternatives are provided. The agent must infer that this retrieves board data from the required resource_id, but no context is given about when to prefer this over other document retrieval tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.