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

Beyond the readOnlyHint annotation, the description explains what the tool returns (full file inventory plus text contents), why served pages are not acceptable substitutes (injected runtime), and that stored files are the sole source of truth. This gives the agent a clear, safe behavioral model of the read 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?

The description is long but front-loaded with the most critical instruction and nearly every sentence carries operational value. It loses slight points because the closing point about forms/data/bookings surviving edits is more relevant to update_project_files than to this read tool.

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?

There is no output schema, so the description carries the burden of explaining return behavior, which it does: full inventory plus text contents, or just inventory with listOnly. Combined with complete parameter schema coverage and a clear read-only safety profile, the agent has everything needed to call the tool correctly.

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 100%, so the baseline applies. The description adds meaningful parameter guidance by recommending listOnly first on large sites and then fetching specific paths, and by clarifying that paths select files while omitting paths retrieves all text files. This goes beyond the schema's basic descriptions.

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 names a specific action and resource: reading the current live source files of a deployed Dplooy project. It further distinguishes itself from scraping the site URL and from the update tool, so an agent can tell exactly what this tool is for.

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 explicitly states when to call this tool (before editing an existing site), how to approach large sites (listOnly first, then fetch specific paths), and what not to do instead (never scrape the site, never rely on memory). It also names the correct follow-up tool, update_project_files, and warns against full redeploys.

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