Skip to main content
Glama

Open Document

open_document

Opens an existing .FCStd file as the active FreeCAD document and returns its document name and object list for subsequent design or automation tasks.

Instructions

Open an existing .FCStd file, make it active. Returns doc name and object list.

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": {
      "path": "<path>"
    },
    "name": "open_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
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 safety profile is covered. The description adds that the doc becomes active and lists the return content, but does not state what happens to a currently active document, error behavior for missing/invalid files, or whether the workspace scoping matters here.

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 short sentences, front-loaded with the action and the state change, then the return values. No filler.

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?

No output schema exists, and the description supplies the return shape (doc name and object list), which is exactly the missing piece. For a simple two-parameter open tool this is nearly complete, only lacking failure-mode context.

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 50% — the workspace parameter is documented in-schema but 'path' is not. The description compensates partially by stating the path must point to a .FCStd file, but adds nothing about absolute vs relative paths or how workspace interacts with the open document.

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?

Specific verb+resource: opens an existing .FCStd file and makes it active, and it declares the return values. It implicitly distinguishes itself from new_document and set_active_document by requiring an existing file, but never names those siblings, so differentiation requires inference.

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?

Usage is implied by the verb — open an existing document. There is no explicit when-to-use/when-not guidance, no mention of set_active_document as the alternative for already-open docs, and no prerequisite notes (file must exist on disk).

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