openl Restore Project Local Change

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

Adds context beyond annotations: session-based project context, requirement for project to be opened, and limitation on repository 'local'. No contradiction with annotations. Could explicitly mention overwriting nature.

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?

Concise two sentences plus a note. Front-loads core action. Every sentence adds value. No fluff.

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 prerequisites, limitations, and parameter source. Missing description of return values/output, but annotations and schema cover some. Adequate for an agent to use correctly.

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?

Adds meaning beyond schema by specifying historyId source (from openl_list_project_local_changes) and explaining absence of projectId. For response_format, schema already describes it well. Baseline 3 plus extra for historyId context.

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 the action (restore), resource (project), and source (local history). Mentions specific historyId from sibling tool. Differentiates from listing and other operations.

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 prerequisites (project opened) and limitations (not for 'local' repository). Explains session context. Lacks explicit guidance on when to use vs alternatives, but constraints are well covered.

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