Skip to main content
Glama

works_open

Downloads a homepage work and opens it in a new editor window for inspection, returning the window PID, official instance ID, and project directory.

Instructions

下载一个首页作品并在新的编辑器窗口里打开,与在首页点开作品同一流程(不弹版本升级提示,工程处于未保存状态)。返回窗口 pid、官方 instance_id 和工程目录,之后可用 get_scene、capture_preview 等官方工具观察它的做法。看完用 project_close(discard_changes=true)关窗,再 works_cleanup 删除下载;窗口开着时工程不会被删除。

Input Schema

NameRequiredDescriptionDefault
instance_idNo官方 list_instances 返回的 instance_id,与 project_path 二选一。
template_idYesworks_list / works_search / works_by_effect 返回的 template_id。
project_pathNo目标工程的绝对路径。与 instance_id 二选一;只开了一个工程窗口时都可省略。

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it discloses that no version-upgrade prompt appears, the project is left unsaved, the return payload (window pid, official instance_id, project directory), and the important constraint that the project cannot be deleted while the window is open.

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?

Purpose is front-loaded, then the workflow and cleanup sequence follow in a logical order. It is dense but nearly every clause carries operational information; only the closing cleanup sentence is slightly verbose.

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

Completeness5/5

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

There is no output schema, but the description explicitly enumerates the return values and the required teardown steps, so an agent knows both what it gets back and how to clean up. Nothing essential for correct invocation is missing.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents template_id, instance_id, and project_path including the either/or relationship. The description adds no parameter-level detail beyond what the schema provides, so the baseline 3 applies.

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

Purpose5/5

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

The description states a specific verb and resource ('下载一个首页作品并在新的编辑器窗口里打开') and pins down the exact semantics by equating it to clicking a work on the homepage. This distinguishes it from siblings like project_open (existing project) and works_download (download only).

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

Usage Guidelines4/5

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

It lays out a full lifecycle: open, observe with get_scene/capture_preview, close with project_close(discard_changes=true), then works_cleanup. That is clear when-to-use and follow-up guidance, though it never explicitly contrasts with project_open or works_download as alternatives.

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