read_entity
Fetch a specific entity's page by name to retrieve its stored audit details from the governance system.
Instructions
读取单个 entity 页。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | entity 名称(不含 .md 后缀) |
Fetch a specific entity's page by name to retrieve its stored audit details from the governance system.
读取单个 entity 页。
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | entity 名称(不含 .md 后缀) |
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 disclose behavioral traits. The verb 'read' implies non-destructive, but it does not explicitly state that, nor does it mention any side effects, return format, or prerequisites. The description adds minimal behavioral context beyond the tool name.
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?
The description is a single, concise sentence with no wasted words. It is appropriately front-loaded and minimal.
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 simple read tool with one parameter, the description is adequate but lacks context such as what an entity page is or how it differs from related tools. Without an output schema, it does not explain return values. It meets the minimum viable standard but has 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%, and the parameter description explains the format (without .md suffix). The description does not add any extra meaning beyond what the schema provides, so the baseline of 3 applies.
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?
The description states a specific verb ('read') and resource ('entity page'), which is clear. However, it does not distinguish this from sibling tools like read_concept or read_think_md, which likely serve similar read purposes.
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 guidance is provided on when to use this tool versus alternatives. It does not mention conditions for using read_entity over read_concept or other read tools, leaving the agent to infer.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.