yuque_get_repo

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only states 'Get a repo by namespace,' which adds no insight beyond the tool name. It does not disclose error behavior, return payload characteristics, or any side effects.

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 a single, efficient sentence with no redundancy. It is appropriately concise for the simplicity of the tool, though it lacks explanatory detail that would make it more useful.

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?

The tool has two parameters, no annotations, and no output schema, yet the description provides only minimal information. It does not explain what a repo is, what the response contains, or how the 'type' parameter affects results. This is insufficient given the rich set of sibling tools.

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 mentions 'namespace' as the lookup key, giving some semantic context for that parameter. However, the 'type' parameter is not mentioned, and with 0% schema description coverage, the description fails to compensate for the missing parameter documentation.

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 clearly identifies the action ('Get') and resource ('repo') and specifies the lookup mechanism ('by namespace'). However, it does not explicitly distinguish from sibling tools like yuque_get_repository_overview or yuque_get_repo_toc, so it is clear but lacks differentiation.

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 yuque_list_repos or yuque_get_repository_overview. It mentions no use cases, prerequisites, or when-not-to-use scenarios.

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