Skip to main content
Glama
LBurny

CADPilot

by LBurny
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

create_document

Generate a new FreeCAD document by providing a name. Use it to begin parametric modeling, assembly, or geometry work.

Instructions

Create a new FreeCAD document.

Args:
    name: Document name. FreeCAD may sanitize or deduplicate it, so read the actual name from the result.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.7.7
    • addedInput schema / properties / name / minLength
      Added value: +1
    • removedInput schema / properties / with_screenshot
      Removed value: -{
-  "anyOf": [
-    {
-      "type": "boolean"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "title": "With Screenshot"
-}
    • removedOutput schema / $defs / ImageContent
      Removed value: -{
-  "additionalProperties": true,
-  "description": "Image content for a message.",
-  "properties": {
-    "_meta": {
-      "anyOf": [
-        {
-          "additionalProperties": true,
-          "type": "object"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null,
-      "title": "Meta"
-    },
-    "annotations": {
-      "anyOf": [
-        {
-          "$ref": "#/$defs/Annotations"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "default": null
-    },
-    "data": {
-      "title": "Data",
-      "type": "string"
-    },
-    "mimeType": {
-      "title": "Mimetype",
-      "type": "string"
-    },
-    "type": {
-      "const": "image",
-      "title": "Type",
-      "type": "string"
-    }
-  },
-  "required": [
-    "type",
-    "data",
-    "mimeType"
-  ],
-  "title": "ImageContent",
-  "type": "object"
-}
    • addedOutput schema / properties / result / items / $ref
      Added value: +"#/$defs/TextContent"
    • removedOutput schema / properties / result / items / anyOf
      Removed value: -[
-  {
-    "$ref": "#/$defs/TextContent"
-  },
-  {
-    "$ref": "#/$defs/ImageContent"
-  }
-]
  2. First observedv0.4.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare non-read-only, non-idempotent, open-world behavior, so the bar is lower. The description adds genuinely useful non-obvious behavior: FreeCAD may sanitize or deduplicate the requested name and the caller should read the actual name from the result. It does not say what happens on name collisions or failures, but the sanitization warning is a meaningful disclosure.

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?

Extremely short, front-loaded with the purpose, and every sentence adds value. The Args block is slightly boilerplate for one parameter but carries real semantic content.

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?

An output schema exists, so return values need not be enumerated, though the description usefully points the agent to read the actual name from the result. What's missing is lightweight usage context (session prerequisites, behavior when the document already exists), which is minor for a one-parameter creation tool.

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 0% for the single 'name' parameter, so the description must compensate. It does so by explaining that the name is not guaranteed to be preserved (sanitized/deduplicated) and that the real value must be read from the output, which the bare string schema does not convey.

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 ('Create a new FreeCAD document'), which is unambiguous and distinguishable from list_documents or session siblings. It does not explicitly contrast itself with sibling tools, but the action is clear enough for selection.

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?

The description gives no when-to-use guidance, no prerequisites (e.g., an open session), and does not mention alternatives such as list_documents. Usage is only implied by the verb 'Create'.

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