openl Create Project Branch

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

Discloses mutation and default behavior (HEAD revision) but does not detail side effects like handling duplicate branch names, permissions, or output. Annotations only indicate openWorldHint.

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?

Three sentences, front-loaded with main action, no wasted words. Efficiently conveys purpose and default behavior.

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?

Explains core action and default revision but fails to describe return values or prerequisites (e.g., project must be open). Missing details on response format beyond schema.

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 already covers all 4 parameters with descriptions (100% coverage). Description adds context about branching from tags/other branches and default revision, providing extra value beyond schema.

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?

Clearly states it creates a branch in a project repository from a revision, tags, or other branches. Distinguishes from sibling tools like openl_list_branches (listing) and openl_create_project_table (creating a table).

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?

Implies usage for creating branches but lacks explicit when-to-use or alternatives. No mention of prerequisites (e.g., project must be open) or when not to use this tool.

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