Skip to main content
Glama

Plan a Workbench clone

plan_clone
Read-onlyIdempotent

Return a read-only plan for a target: compare it against the Workbench profile and list each component as install, present, or manual, with the commands that would run. It still runs a detection probe on the target (same access as inspect_target) but clones nothing and writes nothing. Parameter semantics: components restricts the diff to those ids (default: required+core); workspace sets the expected profile path on the target (default ~/opencode-workbench); profileUrl overrides the git remote. Use it to preview before apply_clone, which performs the changes.

Input Schema

NameRequiredDescriptionDefault
dryRunNoReport only; make no changes.
targetYesThe machine to operate on: this host (local) or a remote host over SSH (ssh).
skipRepoNoDo not clone/update the profile repo on the target.
workspaceNoTarget directory for the profile repo.
componentsNoComponent ids to include; defaults to required+core.
profileUrlNoOverride profile git URL.

Output Schema

NameRequiredDescriptionDefault
stepsYesPer-component plan.
targetYesLabel of the inspected target.
inspectYesFull inspection of the target.
toInstallYesComponent ids that will be installed.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedOutput schema / properties / inspect / properties / npmPrefix
      Added value: +{
      +  "description": "npm global prefix, if npm is installed.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / inspect / properties / opencodeVersion
      Added value: +{
      +  "description": "Version the opencode binary reports, without a leading v (e.g. 2.2.1).",
      +  "type": "string"
      +}
    • addedOutput schema / properties / inspect / properties / osIdLike
      Added value: +{
      +  "description": "ID_LIKE from /etc/os-release: space-separated distribution family hints.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / inspect / properties / shell
      Added value: +{
      +  "description": "The target user's login shell.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / inspect / properties / skillsCount
      Added value: +{
      +  "description": "Number of SKILL.md files under the target's ~/.config/opencode/skills.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint, but the description adds non-obvious behavior: a detection probe still runs on the target with the same access requirements as inspect_target, and nothing is cloned or written. It does not say what happens if the target is unreachable or what the probe requires beyond access parity.

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?

Front-loaded with the outcome, then behavior, then parameters, then routing to apply_clone — every sentence carries weight. It is dense, however: the parameter clause is a single run-on segment packing three defaults.

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?

Covers purpose, safety, side effects, target access, key parameter defaults, and the sibling relationship; return values need not be explained because an output schema exists. An agent has everything needed to choose and call it correctly.

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% and the schema already documents the defaults for components, workspace, and profileUrl, so the description mostly restates structured data. 'Restricts the diff to those ids' adds a little framing but not new syntax or formatting guidance.

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?

Names a specific verb and output artifact ('return a read-only plan') and enumerates the exact result vocabulary (install/present/manual), which no sibling provides. It also explicitly distinguishes itself from both inspect_target (shares access) and apply_clone (performs changes).

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?

States the intended sequencing clearly: 'Use it to preview before apply_clone, which performs the changes' — a genuine when-to-use rule with a named alternative. There is no explicit exclusion (e.g., when a full verify_clone is preferable), 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.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.