Get SiYuan Database

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It does not mention that this is a read-only operation, whether pagination is handled, or any edge cases like invalid IDs. The description is too brief to provide meaningful transparency beyond the obvious semantics of 'Get'.

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, short sentence that immediately states the tool's purpose. There is no filler or repetition, and the key information is front-loaded.

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?

The description, combined with the schema, is adequate for a simple getter tool. However, since there is no output schema, the description should have explained more about the return structure or pagination behavior. It only vaguely says 'structure and data'.

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?

The input schema provides full descriptions for all four parameters (avID, page, viewID, pageSize), so the baseline is 3. The description does not add any parameter-specific meaning; it only says 'structure and data' at a high level, which is already implied by the tool name.

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 clearly states the tool retrieves the structure and data of a SiYuan Attribute View database. The verb 'Get' is specific and distinguishes it from sibling tools like av_addRow, av_updateRow, av_deleteRow, and av_createAttributeView, which perform modifications or creation.

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?

The context of when to use this tool is clear, as it is the only sibling tool explicitly for reading database structure and data. However, it does not explicitly mention alternatives or exclusions, so it falls short of the highest score.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.