get_repo

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

With no annotations, the description must disclose behavior on its own. It only mentions parameter defaults, omitting details about error handling, rate limits, authentication, or read-only status. While 'get' implies non-mutating behavior, the description adds minimal transparency beyond the function name.

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 very concise, with a one-sentence purpose followed by a clean argument list. Every line serves a purpose, and there is no redundant or vague filler.

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 simple retrieval tool with an output schema, the description covers the basic purpose and parameter semantics. However, it lacks usage guidelines and behavioral context, such as what 'default' refers to or how errors are handled, making it only minimally complete for an agent.

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 description assigns meaning to both parameters by calling them 'workspace slug' and 'repository slug' and explains that they use defaults. Given the 0% schema description coverage, this is essential. However, it does not specify how defaults are determined, leaving some ambiguity.

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 'Get repository details' clearly states the action and target resource, making the core purpose obvious. However, it does not explicitly differentiate itself from sibling tools like list_repos, though the singular 'repository' and use of repo/workspace parameters imply a single-repo lookup.

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 provides no guidance on when to use this tool versus alternatives such as list_repos or get_pull_request. The only usage-related note is that workspace and repo slugs default if not provided, but it does not explain the intended context or when to avoid using this tool.

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