noark5_entity_links

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

With no annotations, the description carries the burden of behavioral disclosure. It reveals the four link categories, notes that entities can have multiple parents, and explains query-template URLs. This makes the read-only discovery purpose clear.

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 well-structured with a clear opening, bullet-like category details, and usage pointers. The final sentence 'Returns categorized list of links with URLs and descriptions' is somewhat redundant with the opening, but it does not bloat the description much.

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 covers categories, usage guidance, parameter semantics, and an output schema exists. However, the reference to the nonexistent 'noark5_navigate_up' tool and the lack of explicit relationship to the similar sibling tools noark5_list_children and noark5_list_parents leave a meaningful completeness gap.

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 0%, so the description must compensate. It defines entity_url as 'the self-href URL of the entity to inspect,' which adds meaningful context beyond the bare schema type. It stops short of an example or how to obtain the self-href, but is adequate.

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 and resource—'List all navigation links on an entity, categorized by type'—which clearly distinguishes it from siblings like noark5_list_children and noark5_list_parents. The category breakdown further clarifies its scope.

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 description gives explicit pointers: use noark5_filter_entities for filtered listing and 'noark5_navigate_up' for parent details. However, 'noark5_navigate_up' does not appear among the sibling tools, and the actual sibling noark5_list_parents is not referenced, making the guidance partially misleading. It also does not contrast against noark5_list_children or noark5_list_parents.

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