ByJG Open Source Docs

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

With no annotations, the description carries the burden of clarifying behavior; it clearly states the operation is a read that returns full markdown, not a mutation or search. It does not spell out failure behavior for invalid source paths, but for a simple read tool with an output schema that is a minor omission.

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?

Two sentences with no filler; the core behavior is first, the addressing constraint second, and the usage trigger is folded into the final clause. Every phrase adds operational value.

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?

For a one-parameter read operation with an output schema and sibling tools that handle search and listing, this description provides the path source, an example, and the condition that should trigger the call. Nothing operationally necessary is missing.

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%, but the description fully compensates by explaining that source_path is the source path from a search result and giving a concrete example ('php/micro-orm/active-record.md'). The agent knows exactly what value to pass and where to find it.

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 states an explicit verb-result pair ('Return the full markdown') and the resource ('one documentation page'), plus the addressing mechanism ('source path'). It is easily distinguishable from siblings: search_docs finds hits, list_projects lists projects, get_document retrieves an individual page.

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?

It gives a clear trigger: 'Use it when a search hit is relevant but truncated and you need the whole page.' It also tells the agent to obtain the path from a search result. It doesn't enumerate exclusions like 'do not use it to browse all documents,' but the stated condition is sufficient for a single-purpose retrieval tool.

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

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

With no annotations provided, the description carries the behavioral disclosure burden. It discloses that the tool returns a complete inventory grouped by category and project with document and passage counts, and its list-oriented nature with no parameters implies a safe, read-only operation.

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?

Two sentences with zero filler. The core output scope and grouping are front-loaded first, and the usage guidance is placed second, making the description efficient and easy to parse.

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?

For a zero-parameter tool, the description covers what is returned, how it is organized, and when to use it. An output schema exists, so the description correctly does not repeat return-field details.

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 tool has zero parameters, and the baseline for parameter semantics is 4. The description adds no parameter details because none are needed; there is nothing for an agent to configure or misinterpret.

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 states a clear verb and resource: 'Inventory of everything indexed, grouped by category and project, with document and passage counts.' This distinguishes it from siblings like search_docs and get_document by framing it as a discovery tool to use before searching.

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?

Explicitly says 'Use it to discover which ByJG libraries have documentation before searching,' clearly indicating when to invoke it. It implies searching is the alternative but does not explicitly name the sibling tools; however, sibling names are available in context, making the guidance effective.

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

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.