Server Quality Checklist

Tool Scores

• get_apic_tocA
  3.8/5.0
  Behavior3/5

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

  No annotations are present, so the description carries the full burden. It states that the tool returns the full document structure with sections and topics, which is helpful, but it does not disclose the output format, potential size of the TOC, or how the optional section filter affects the result.

  Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

  Conciseness5/5

  Is the description appropriately sized, front-loaded, and free of redundancy?

  Two concise sentences with no filler. The core purpose is front-loaded, and the description of what is shown adds useful detail without bloat.

  Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

  Completeness4/5

  Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

  For a simple read-only tool with zero required parameters and one self-explanatory optional parameter, the description gives enough context for an agent to call it appropriately. The only minor gap is lack of detail about the exact return structure, but this is low risk for a TOC retrieval tool with no output schema.

  Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

  Parameters3/5

  Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

  The input schema already describes the single optional section parameter with examples, and schema description coverage is 100%. The tool description adds no additional meaning about the parameter, so the schema can handle parameter understanding on its own.

  Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

  Purpose5/5

  Does the description clearly state what the tool does and how it differs from similar tools?

  The description uses a specific verb and resource: getting the table of contents for IBM API Connect 12.1.0 documentation. It also clarifies what the tool returns ('full document structure with sections and topics'), which separates it from the sibling search and read tools.

  Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

  Usage Guidelines3/5

  Does the description explain when to use this tool, when not to, or what alternatives exist?

  The description implies this tool is for exploring the document overview rather than searching or reading specific content, but it never explicitly states when to use this tool over search_apic_docs or read_apic_doc. No exclusions or alternative guidance are provided.

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

• search_apic_docsA
  3.8/5.0
  Behavior3/5

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

  No annotations are provided, so the description carries the full burden of behavioral disclosure. It does disclose the output format (titles, snippets, URLs), which is helpful, but it says nothing about match semantics, result ordering, no-match behavior, or pagination. The description is not misleading, but it is thin on behavioral detail.

  Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

  Conciseness5/5

  Is the description appropriately sized, front-loaded, and free of redundancy?

  The description consists of two short, purposeful sentences. The first identifies the action and resource; the second specifies the return content. There is no filler or redundant text.

  Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

  Completeness4/5

  Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

  For a relatively simple search tool, the description covers the core contract: what it searches and what it returns. The schema documents the parameters, and the output shape is stated. It lacks an explicit pointer to sibling tools, but the agent can still invoke this tool confidently without additional context.

  Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

  Parameters3/5

  Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

  Schema description coverage is 100%: all parameters (query, limit, start) already have descriptive comments. The description adds no additional parameter-level guidance, so the baseline score of 3 applies.

  Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

  Purpose5/5

  Does the description clearly state what the tool does and how it differs from similar tools?

  The description clearly states the operation ('Search'), the target resource ('IBM API Connect 12.1.0 documentation'), and the expected result shape ('matching topics with titles, snippets, and URLs'). This makes it easily distinguishable from sibling tools read_apic_doc and get_apic_toc, which imply different operations.

  Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

  Usage Guidelines3/5

  Does the description explain when to use this tool, when not to, or what alternatives exist?

  The description implies usage: when you need to search the API Connect 12.1.0 documentation. However, it provides no explicit guidance about when to use read_apic_doc or get_apic_toc instead, nor any exclusions or conditions. The usage context is clear but not fully stated.

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

• read_apic_docA
  4.2/5.0
  Behavior3/5

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

  With no annotations provided, the description carries the full behavioral disclosure burden. It does disclose the core behavior—reading a documentation page and returning Markdown—but says nothing about failure modes, access requirements, or side effects. For a simple read-only tool this is adequate but not rich.

  Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

  Conciseness5/5

  Is the description appropriately sized, front-loaded, and free of redundancy?

  The description is a single efficient sentence that states the action, target, and output format, followed by a practical instruction for obtaining the parameter. Every word earns its place.

  Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

  Completeness4/5

  Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

  For a one-parameter tool with no output schema and no annotations, the description covers the essential information: what the tool does, what it returns, and where the href comes from. It is slightly lean on potential edge cases like invalid hrefs, but not enough to be called incomplete for typical use.

  Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

  Parameters4/5

  Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

  The schema already fully describes the 'href' parameter with 100% coverage, so the baseline is 3. The description adds meaningful value by telling the agent that the href comes from search results or TOC, which clarifies the parameter source and validates the expected value format.

  Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

  Purpose5/5

  Does the description clearly state what the tool does and how it differs from similar tools?

  The description uses a specific verb ('Read'), identifies the exact resource (a specific IBM API Connect documentation page), and specifies the output format (Markdown). It is clearly distinguished from sibling tools by explaining that its input comes from search results or TOC, making its role in the workflow clear.

  Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

  Usage Guidelines4/5

  Does the description explain when to use this tool, when not to, or what alternatives exist?

  The instruction to use the 'href' from search results or TOC gives direct guidance on when and how to invoke this tool relative to its siblings. It does not explicitly name the alternative tools or state when not to use it, but the provenance guidance strongly implies the intended workflow.

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