create_entity_link

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

With no annotations, the description carries the full burden but only states the action 'create' without disclosing side effects, permission requirements, uniqueness constraints, or reversibility. The behavioral expectations beyond the basic mutation are entirely unspecified.

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 brief, but the brevity comes at the cost of omitting important contextual information. It is a single tautological sentence rather than a well-structured concise description, making it neither appropriately informative nor efficient.

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?

Despite having an output schema, the description does not explain the entity types (project, portfolio, goal) or relationship semantics beyond what the schema lists. It lacks clarification on handling duplicate links or bidirectional behavior, leaving significant ambiguity for an agent selecting this tool.

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 the schema already documents all four parameters. The description's 'between entities' subtly reinforces the source/target relationship, but it adds no details about valid values or relationships that aren't already in the schema.

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 'Create a link between entities' is a direct restatement of the tool name create_entity_link, adding no new information. It fails to distinguish from related tools like link_issues or list_entity_links without relying on the schema.

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 regarding when to use this tool versus alternatives such as link_issues (for issue links) or when not to use it. The description lacks context about prerequisites or typical use cases.

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