Skip to main content
Glama

typora_open_document

Destructive

Open an existing Markdown document in the selected renderer and wait until Typora confirms its path. Use it to load files for inspection or automation through the MCP bridge.

Instructions

Open an existing Markdown document in the selected renderer and wait until Typora confirms its path. Fixture validation uses a stricter MCP-owned launch flow.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
targetIdNoRenderer targetId from typora_status; required when no single window is focused

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered. The description usefully adds the synchronous behavior ('wait until Typora confirms its path'), but it never discloses what the destructive effect is—e.g. that opening a document replaces the currently loaded document.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with the core action front-loaded and no wasted words. The trailing fixture sentence is slightly ambiguous but does carry routing information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, no-output-schema operation, the description omits key context: what happens to the currently open document, whether permissions or a running Typora instance are required, and how 'selected renderer' is determined. Annotations cover the safety hint but not the behavioral detail an agent needs.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 50%: targetId is documented in the schema (referencing typora_status), but the required path parameter has no description. The phrase 'selected renderer' loosely gestures at the renderer/targetId concept but adds no concrete guidance, so the description does not compensate for the gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Open) and resource (existing Markdown document) plus scope (in the selected renderer), so the agent knows exactly what happens. It does not, however, explicitly distinguish itself from siblings like typora_launch or typora_run_fixture, leaving that routing to inference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use statement. The second sentence, 'Fixture validation uses a stricter MCP-owned launch flow,' is an indirect 'when not to use this' hint pointing at the fixture path, but no alternatives are named directly, so usage is only implied.

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