open_in_editor

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

With no annotations, the description carries the full burden and does well: it discloses the side effect (the editor imports the doc and stores it as a NEW project in this device's browser, no login required), the port default of 5390 with DINGCARD_APP_PORT override and free-port fallback, and what open:false returns. It does not say whether repeated calls create duplicate projects or what happens if the local server cannot start, so it is not exhaustive.

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?

One dense paragraph, front-loaded with the action and purpose, then environmental details. Every clause carries information, though the parenthetical about ports and the env-var precedence could be tightened.

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 six-parameter, all-optional tool with no output schema and no annotations, the description covers the purpose, the environment prerequisites, the side effect on the editor, and the return value when open is false. Only edge behavior (failures, repeat invocations) is left unstated.

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 the schema already documents all six parameters and the baseline would be 3. The description adds real value on top: it clarifies the precedence of appUrl over the default port, the meaning of open:false as returning only the url, and that the editor persists to local browser storage — context the schema text does not convey.

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 states a specific verb and resource — opening this free-canvas document in the DingCard editor so a human can continue editing by hand — and explains the mechanism (server hosts the doc at a local address, browser opens the editor's import link, editor stores it as a new project). That is clearly distinct from siblings such as render_document (produces output) or share_document (shares a link).

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?

It gives a clear context for use: when a person needs to keep editing the document manually rather than programmatically. It also spells out the variants — default local editor, DINGCARD_APP_URL/appUrl override, and open:false to just get the URL. It never names a sibling tool as an alternative or exclusion, so it stops short of a 5.

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