Skip to main content
Glama

Set Active Document

set_active_document

Switch the active document by name to control which document receives subsequent FreeCAD operations. Use the name returned by new_document or open_document.

Instructions

Switch the active document by name (the value returned from new_document/open_document).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "set_active_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
workspaceNoRun this call in this named workspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=false, so the agent knows this is a non-destructive mutation. The description adds nothing beyond that — it does not say what happens if the name is not found, whether the switch affects other sessions or workspaces, or what the call returns.

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?

A single sentence, front-loaded with the action and immediately followed by the parameter's provenance. Nothing extraneous and no filler.

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

Completeness3/5

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

For a simple state-switch tool with annotations covering safety, the description is nearly adequate — the key gap is that no output schema exists and the description never says what the call returns or how failures are surfaced. It also leaves the relationship to use_workspace/open_document unexplained.

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 only 50%: the 'workspace' param is documented in the schema, but the required 'name' param has no schema description. The description compensates by defining exactly what value 'name' expects (the handle returned by new_document/open_document), which is meaningful semantics an agent could not get from the schema alone.

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 and resource ('Switch the active document by name') and identifies the value source for the required argument. It does not differentiate itself from adjacent siblings such as open_document or use_workspace, so an agent must infer the boundary.

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?

The parenthetical 'the value returned from new_document/open_document' implies this is a follow-up step after creating or opening a document, which is useful implied usage. However, there is no explicit when-to-use/when-not, and no statement about how it relates to use_workspace or open_document (which presumably also changes the active context).

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

Deploy Server

Other Tools