Skip to main content
Glama
LBurny
by LBurny

create_document

Create a new FreeCAD document by specifying a name, and optionally capture a screenshot to verify the outcome.

Instructions

Create a new document in FreeCAD.

Args:
    name: The name of the document to create.
    with_screenshot: Attach a screenshot of the result (default: no screenshot).

Returns:
    A message indicating the success or failure of the document creation.

Examples:
    If you want to create a document named "MyDocument", you can use the following data.
    ```json
    {
        "name": "MyDocument"
    }
    ```

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
with_screenshotNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It discloses that the tool returns a success/failure message and that with_screenshot attaches a screenshot, but it does not mention any requirements like a running session, potential side effects on the FreeCAD environment, or whether the operation is synchronous. This is a significant gap for a tool that creates an object.

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

Conciseness4/5

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

The description is concise, structured into Args, Returns, and an example. The example is helpful without being verbose. It could omit the Returns line since an output schema exists, but it remains efficient.

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?

The tool is simple and the output schema covers return structure. However, the description does not integrate with the session context visible in sibling tools (e.g., session_start, list_documents). An agent may not know whether a session must be active before creating a document.

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%, but the description compensates by explicitly stating that name is 'the name of the document' and with_screenshot 'attaches a screenshot' with a default of no screenshot. This adds meaning beyond the schema's type-only definitions.

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 opens with 'Create a new document in FreeCAD', which is a specific verb+resource+domain statement. It clearly distinguishes this tool from siblings like list_documents or get_objects by focusing on creation of a document.

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 example shows how to use the tool, but there is no explicit guidance on when to use it versus alternatives, nor are any exclusions or prerequisites mentioned. The intended use is implied by the name and description but not elaborated.

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/LBurny/cadpilot'

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