read_artifact

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is fully covered by structured data. The description adds only the artifact-type scope; it says nothing about behavior on a missing/invalid path, whether binary or large files are handled, or what form the content comes back in.

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?

A single front-loaded sentence with no filler; the verb, resource, and lookup key come first. It loses a point only for the vague 'etc' tail, which adds ambiguity rather than information.

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?

This is a simple two-parameter read tool whose annotations cover safety and whose schema is fully documented, so little is missing. However, since there is no output schema, the description should say what is returned (raw file text? parsed structure?) and how a missing path is reported; that gap leaves the definition adequate but not complete.

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 description coverage is 100%, with both 'path' and 'repo' documented in the schema (including the VBS_WORKSPACE_DIR/VBCS_REPO_PATH resolution order and the list_repos pointer), so the schema carries the load. The description merely echoes 'by repo-relative path' and adds no format or resolution detail beyond it, matching the baseline 3.

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 (Read) plus resource (VBCS artifact file) and scoping mechanism (repo-relative path), and enumerates example artifact types (page/flow/chain/service JSON). An agent can distinguish it from write_artifact, list_artifacts, and search_artifacts by the retrieval-by-path semantics, though no sibling is named explicitly.

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?

Usage is only implied: the required 'path' parameter and the 'by repo-relative path' phrasing suggest this is for fetching a known file, in contrast to search_artifacts or list_artifacts for discovery. The description never states when to use it, when not to, or which alternative fits a given situation.

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