Skip to main content
Glama

spawnWorkspace

Initiate a bridge process for a specified workspace directory, returning port and auth token. Optionally wait for extension handshake or spawn code-server.

Instructions

Spawn claude-ide-bridge for a workspace dir. Returns pid/port/authToken once lock appears; optionally waits for extension handshake.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesAbsolute path to the workspace directory to open
portNoPort for the spawned bridge (optional; picks a free port if omitted)
timeoutMsNoMax ms to wait for bridge lock (and extension handshake when waitForExtension=true). Default 30000.
tokenNoFixed auth token for the spawned bridge (optional)
waitForExtensionNoIf true, poll /health on the spawned bridge until extensionConnected=true. Shares the timeoutMs budget.
codeServerNoIf true, also spawn `code-server` against the workspace (prereq: installed on PATH with extension pre-loaded). Implicitly enables waitForExtension.
codeServerPortNoPort for the spawned code-server (default: 8080). Ignored when codeServer=false.
codeServerBinNoOverride code-server binary path (default: 'code-server' on PATH).
Behavior4/5

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

With no annotations, the description carries full burden. It discloses the return value (pid/port/authToken), waiting for a lock, and optional extension handshake. It does not mention side effects or safety, but for a spawn tool, these are the key behaviors. It adds value beyond the schema.

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

Conciseness5/5

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

Two sentences with no extraneous information. The first sentence states the core action, the second details the output and optional behavior. Front-loaded with the verb and resource, every word earns its place.

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

Completeness4/5

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

Given the 8 parameters and no output schema, the description covers the main purpose, return value, and key optional behavior (waitForExtension). However, it does not explain advanced options like codeServer or what 'bridge lock' means. The schema compensates for these gaps, so it is mostly complete.

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 coverage is 100%, so baseline is 3. The description does not repeat parameter descriptions but adds context about the return flow and waitForExtension behavior, which helps understand the overall semantics but does not significantly enhance individual parameter meaning beyond the schema.

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 clearly states the verb 'spawn' and the resource 'claude-ide-bridge for a workspace dir', and distinguishes itself from sibling tools by specifying the unique action of spawning a bridge, which no other sibling tool does.

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?

The description provides clear context for when to use this tool (to spawn a bridge for a workspace) and mentions the optional waitForExtension behavior, giving implicit guidance on when to set that parameter. However, it does not explicitly exclude alternatives or state when not to use it.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Oolab-labs/patchwork-os'

If you have feedback or need assistance with the MCP directory API, please join our Discord server