Skip to main content
Glama

List Documents

list_documents
Read-only

List all open FreeCAD documents in a workspace, returning each document's name, file path, dirty/active status, and object count.

Instructions

List all open documents: [{name, label, file_path, dirty, active, object_count}, ...].

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault
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

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description's contribution is the returned field set (name, label, file_path, dirty, active, object_count), which is genuinely useful since there is no output schema, but it says nothing about ordering, empty-result behavior, or whether the listing spans all workspaces or just the current one.

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 front-loaded sentence with zero filler; the field enumeration is compact and placed immediately after the scope statement.

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?

With no output schema the description helpfully supplies the result shape, which is appropriate for a simple read tool. However, it leaves the workspace parameter's effect and the relationship to list_objects/list_workspaces unexplained, which are the main remaining gaps for an agent picking this tool.

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?

Only one optional parameter (workspace) and schema coverage is 100%, so the schema already carries the semantics. The description adds no information about how workspace scoping affects the returned document set, so the baseline 3 applies.

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 (list open documents) and enumerates the returned fields, which makes the tool's scope concrete. It does not explicitly distinguish itself from siblings such as list_objects or open_document, but the 'open documents' framing is unambiguous.

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

Usage Guidelines2/5

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

No guidance on when to call this versus alternatives like list_objects or list_workspaces, and no prerequisites or exclusion conditions are given. An agent must infer usage purely from the name and the field list.

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