read_project

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

No annotations are provided, so the description carries the burden. 'Read' plus the named return content establishes it as a non-mutating fetch, which is useful, but it says nothing about permissions, failure modes when the project is absent, or freshness of the draft/file lists.

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 short sentences, front-loaded with the action and return payload, then the usage context. No filler or repetition.

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?

An output schema exists, so the description needn't detail return values, and the one-parameter read surface is modest. The remaining gap is resolving the 'default' project_name and behavior when the project does not exist.

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% for the single project_name parameter, and the description only implies it via 'a repo-managed project.' It does not explain what the default value 'default' resolves to or how a repo-managed project name is formed.

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) and resource (repo-managed project) plus the two things returned: prompt and sync/draft file lists. The 'repo-managed' qualifier distinguishes it from the directory-project siblings, though it never names them 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?

Explicitly says when to use it: 'before editing or syncing a repo project to understand current project intent and files.' That is a clear context trigger, but there are no stated exclusions or named alternatives (e.g. read_directory_project).

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