openl Save Project

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

Discloses key behaviors: creates a new revision, transitions project to OPENED, optionally closes, validates before saving if endpoint available. These details go far beyond the openWorldHint annotation, which is minimal. No contradictions.

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?

Five sentences, each providing essential information. Front-loaded with main purpose. No redundant or missing information. Highly efficient.

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?

Covers preconditions (EDITING status, not local), postconditions (revision, status change), optional behaviors, validation, and usage context. Without output schema, the description sufficiently explains what happens upon invocation.

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 100%, so baseline is 3. Description adds value by specifying exact usage for projectId (from openl_list_projects response) and explaining comment requirement in context of status transitions. closeAfterSave and response_format are also clarified.

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?

Description clearly states the tool saves project changes to Git, which is a specific action on a resource. It distinguishes from siblings by specifying when to use (after edits) and when not (for local repository).

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?

Provides explicit conditions: works only when project status is EDITING, requires comment, and does not work for repository 'local'. Mentions use after update_table/append_table. Lacks explicit when-to-use-alternatives for siblings, but closeAfterSave option is explained.

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