Skip to main content
Glama

Install one Workbench component

install_component
DestructiveIdempotent

Install one Workbench component by ID on a local or SSH target. Returns a plan without confirm; set confirm true to write files. Use apply_clone for the full default set.

Instructions

Install a single Workbench component by id (e.g. node, opencode, npm-mcps, skills) on a target; component must be an id from describe_workbench. Overwrites that component's files when present (e.g. skills/plugins replace the copies under <home>/.config/opencode); global installs need write permission and can take minutes. Idempotent and consent-gated: without confirm:true it returns the plan. Parameter semantics: component is required; workspace defaults to ~/opencode-workbench; confirm defaults to false (plan only). Use it for one targeted component; use apply_clone to install the full default set.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetYesThe machine to operate on: this host (local) or a remote host over SSH (ssh).
confirmNoSet true to actually install. When absent, the call returns a plan and makes no changes.
componentYesComponent id from describe_workbench.
workspaceNoTarget directory for the profile repo.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
planNoPresented when confirmation is required.
modelYesDefault model selected for the target (DeepSeek when its key is present, else the OpenCode Zen free floor).
dryRunYesTrue when the run made no changes.
targetYesLabel of the target.
envPathYesPath of the written ~/.env.workbench template.
envVarsYesEnvironment variable names listed in the env template.
skippedYesComponent ids skipped (already present or manual).
degradedYesCapabilities disabled because required credentials are absent; fill the named env vars to enable them.
installedYesComponents installed, with exit codes and output.
workspaceYesDirectory where the profile repo was cloned.
configPathYesPath of the written opencode.json.
providerModeYesWhich provider the model resolves to.
requiresConfirmationNoTrue when the call returned a plan without applying; re-call with confirm:true to install.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv4.0.1

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the destructiveHint/idempotentHint annotations: it names exactly what gets overwritten (skills/plugins replacing copies under <home>/.config/opencode), that global installs require write permission and can take minutes, and that without confirm:true it returns a plan and makes no changes. The overwrite disclosure is consistent with destructiveHint=true.

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 core action, then packs overwrite/timing/consent details into dense clauses. Every sentence carries information, though the single long middle sentence is heavily parenthetical and slightly harder to parse than necessary.

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?

For a consent-gated, destructive, environment-dependent install tool with a nested target object, the description covers side effects, permission needs, latency, default plan-only behavior, and sibling routing. With an output schema present, return values need not be restated.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds value the schema omits: default values for `workspace` (~/opencode-workbench) and `confirm` (false, plan only), and confirms `component` is required. It does not explain the nested `target` object's ssh fields, which the schema already covers.

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?

Opens with a specific verb+resource+topic: 'Install a single Workbench component by id', and enumerates example ids. It also implicitly distinguishes itself from remove_component/update_component by scoping to installation of one component.

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

Usage Guidelines5/5

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

Explicitly routes the agent: 'Use it for one targeted component; use apply_clone to install the full default set.' It also states the prerequisite that `component` must be an id from describe_workbench, giving both when-to-use and where-to-get-inputs guidance.

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