Server Quality Checklist

Tool Scores

• ingest_pdfsB
  3.1/5.0
  Behavior2/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 describes a write operation (creating output.json and adding to an index) but lacks details on permissions, side effects, error handling, or rate limits. This is a significant gap for a tool that modifies data without safety annotations.

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

  Conciseness4/5

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

  The description is concise and structured into two sentences that efficiently convey the tool's action and purpose. However, it could be slightly more front-loaded by starting with the primary goal (enabling knowledge base querying) rather than the procedural steps.

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

  Completeness3/5

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

  Given the tool has an output schema (which handles return values) and no parameters, the description is minimally adequate. However, as a write operation with no annotations, it lacks completeness in explaining behavioral traits like data mutation effects or integration with sibling tools, leaving gaps for safe agent 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 input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description adds context by implying the tool operates on documents in an input folder, which is useful semantic information beyond the empty schema. Baseline is 4 for zero parameters.

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

  Purpose4/5

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

  The description clearly states the tool's purpose: it processes documents from an input folder to create an output.json file and adds them to an index for knowledge base querying. It specifies the verb ('takes', 'creates', 'adds') and resource ('documents', 'output.json', 'index'), but does not explicitly differentiate from sibling tools like 'add_text_to_index' or 'index_documents', which may have overlapping functions.

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

  Usage Guidelines2/5

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

  The description provides no guidance on when to use this tool versus alternatives such as 'add_text_to_index' or 'index_documents'. It mentions the tool's action but does not specify prerequisites, exclusions, or comparative contexts, leaving the agent to infer usage based on tool names alone.

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

• query_knowledge_baseA
  3.7/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 burden. It discloses key behavioral traits: it returns 'the top-2 documents' content and heading', indicating a limit and format. However, it lacks details on permissions, rate limits, error handling, or how relevance is determined. This provides basic but incomplete behavioral context.

  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 appropriately sized and front-loaded: the first sentence states the purpose, the second specifies the return behavior, and the 'Args' section efficiently explains the parameter. Every sentence adds value with zero waste, making it highly concise and well-structured.

  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?

  Given the tool's moderate complexity (a query operation with one parameter) and the presence of an output schema (which handles return values), the description is reasonably complete. It covers purpose, return format, and parameter semantics. However, it lacks details on behavioral aspects like error cases or performance, leaving minor gaps.

  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 description adds meaningful semantics beyond the input schema. The schema has 0% description coverage (only a title 'Query'), but the description explains that 'query' is 'The search query string', clarifying its purpose and usage. Since there's only one parameter, this adequately compensates for the low schema coverage.

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

  Purpose4/5

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

  The description clearly states the tool's purpose: 'Query the knowledge base for relevant documents.' It specifies the verb ('query') and resource ('knowledge base'), distinguishing it from sibling tools like 'add_text_to_index' or 'ingest_pdfs'. However, it doesn't explicitly differentiate from potential similar query tools, which prevents a perfect score.

  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 by stating it returns documents 'to be used as context', suggesting it's for retrieving background information. However, it provides no explicit guidance on when to use this tool versus alternatives (e.g., if other query tools exist) or any prerequisites. This leaves usage context somewhat vague.

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

• index_documentsA
  3.9/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 describes the action ('reads documents' and 'indexes them'), source ('data/docs.json'), and purpose ('initialize or update the knowledge base'), but lacks details on potential side effects (e.g., overwriting existing data), error handling, or performance characteristics. This is adequate but has gaps for a tool with no annotations.

  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 highly concise and well-structured: two sentences that directly state the tool's function and usage without any redundant or unnecessary information. It is front-loaded with the core action, making it easy to understand quickly.

  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?

  Given the tool's complexity (0 parameters, no annotations, but with an output schema), the description is reasonably complete. It explains what the tool does and when to use it. Since an output schema exists, the description doesn't need to detail return values. However, it could benefit from more behavioral context (e.g., idempotency, error cases) to be fully comprehensive.

  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 tool has 0 parameters, and schema description coverage is 100%, so there are no parameters to document. The description doesn't need to add parameter semantics beyond what the schema provides. A baseline score of 4 is appropriate as it doesn't introduce confusion or omissions regarding parameters.

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

  Purpose4/5

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

  The description clearly states the tool's purpose: 'Reads documents from data/docs.json and indexes them into Elasticsearch.' It specifies the verb ('reads' and 'indexes'), resource ('documents'), and target system ('Elasticsearch'), making it unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'add_text_to_index' or 'ingest_pdfs', which prevents a perfect score.

  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 description provides clear usage context: 'Call this tool to initialize or update the knowledge base.' This indicates when to use it (for initialization or updates) and implies a broader knowledge base context. However, it doesn't explicitly state when not to use it or name alternatives among the sibling tools, such as 'add_text_to_index' for incremental additions.

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

• add_text_to_indexA
  4.1/5.0
  Behavior4/5

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

  With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behaviors: it adds documents to the knowledge base, handles content chunking for documents over 1000 words, and updates both JSON storage and Elasticsearch index. This covers mutation effects, processing logic, and data persistence, though it could mention permissions or error handling.

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

  Conciseness4/5

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

  The description is appropriately sized and front-loaded, with the core purpose stated first, followed by behavioral details and parameter explanations. Every sentence adds value, though the 'Args' section could be integrated more smoothly. It avoids redundancy and is efficient for a tool with two parameters.

  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?

  Given the tool's complexity (mutation with data processing), no annotations, and an output schema present (which handles return values), the description is largely complete. It covers purpose, behavior, and parameters, but could improve by mentioning prerequisites or error cases. The output schema reduces the need to explain return values, making this adequate.

  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 description adds meaningful semantics beyond the input schema, which has 0% description coverage. It explains that 'title' is a descriptive title for the text and 'content' is the actual text content to index, providing clear context for both parameters. This compensates well for the lack of schema descriptions, though it doesn't detail constraints like length or 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 clearly states the tool's purpose with a specific verb ('Adds') and resource ('new text document to the knowledge base'), distinguishing it from siblings like 'index_documents' (which might handle multiple documents or different formats) and 'ingest_pdfs' (which handles PDFs specifically). It specifies the exact action and target resource.

  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 for adding text documents to the knowledge base, but does not explicitly state when to use this tool versus alternatives like 'index_documents' or 'ingest_pdfs'. It provides context (adding text documents) but lacks explicit guidance on exclusions or comparisons to sibling tools.

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