Get Linked Sessions

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

With no annotations, the description carries the full burden and does well: it discloses the underlying table, source/target behavior, auto/manual link handling, Pro tier requirement, and return structure reference. It could be more explicit about failure behavior or non-Pro behavior, but overall it provides meaningful operational context.

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 compact and well-structured: a purpose sentence, a short behavioral paragraph, an Args list, and a return reference. Every sentence adds useful information without redundancy or bloat.

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?

Given only 2 parameters, no annotations, and no output schema, the description covers the essential ground: purpose, data source, link types, Pro tier constraint, parameter semantics, and return structure via a reference to vault_get_session_links. Minor gaps remain around error handling and non-Pro behavior, but the core context is solid.

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 has 0% description coverage, but the description fully compensates by explaining both parameters: session_id is a LoreConvo session UUID, and limit is max results with a default of 5. This adds clear meaning beyond the bare 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 opens with a specific verb and resource: 'Return LoreDocs documents linked to a given LoreConvo session.' It clearly distinguishes this from sibling tools like vault_get_session_links by explaining it queries the cross_product_links table and returns both auto and manual links.

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 implies usage context by explaining what the tool does and the Pro tier requirement for auto-links, but it does not explicitly state when to use this tool vs. alternatives like vault_get_session_links. There is no direct 'use this when...' or 'instead of...' guidance.

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