Search ByJG documentation

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

No annotations are provided, so the description carries the behavioral disclosure burden. It does disclose return contents (passages with public URLs) and the dual matching strategy, but it omits details like what the limit parameter controls, pagination behavior, and whether any auth/rate limits apply.

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?

Three tight sentences: the first states the core action and output, the second clarifies matching behavior with concrete examples, and the third covers optional filters. No filler or redundancy.

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 an output schema exists, return values are already covered structurally. The description is complete for query understanding and filtering, but the missing limit semantics and lack of explicit sibling routing leave a small gap in full invocation confidence.

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 coverage is 0%, so the description must compensate. It adds meaning for query ('natural-language questions and exact symbol names work') and for category/project with concrete examples, but it says nothing about the limit parameter, which remains ambiguous despite its default of 0.

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: 'Search the ByJG open source documentation and return the most relevant passages, each with its public URL.' This clearly distinguishes it from siblings like get_document (full document retrieval) and list_projects (project enumeration).

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 helpful usage context: it supports natural-language questions and exact symbol names, and optionally narrows by category or project. However, it never explicitly tells the agent when to prefer get_document or list_projects instead.

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