Skip to main content
Glama
LBurny
by LBurny

get_objects

Read-onlyIdempotent

List all objects in a FreeCAD document or read a single object's full properties by providing its name.

Instructions

List a document's objects, or read one object's full properties.

Args:
    obj_name: Omit to list the objects; pass a name to read that object instead.
    limit/offset: Page size and start index for the object list.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
offsetNo
doc_nameYes
obj_nameNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv0.7.7
    • addedInput schema / properties / doc_name / minLength
      Added value: +1
    • addedInput schema / properties / limit
      Added value: +{
      +  "default": 50,
      +  "maximum": 500,
      +  "minimum": 1,
      +  "title": "Limit",
      +  "type": "integer"
      +}
    • addedInput schema / properties / obj_name
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Obj Name"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "default": 0,
      +  "maximum": 10000000,
      +  "minimum": 0,
      +  "title": "Offset",
      +  "type": "integer"
      +}
    • 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.9/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and open-world, so the safety profile is covered. The description adds genuine behavioral context beyond that: the tool returns either a list or a single object depending on obj_name, and the list is paginated via limit/offset.

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?

Front-loads the core purpose in the first sentence, then uses an Args block for parameter notes. Every line is relevant; the formatting is slightly repetitive but not wasteful.

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 no explanation, and annotations carry the safety profile. Combined with the mode and pagination guidance, the definition is nearly complete, missing only documentation of the required doc_name parameter.

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 description coverage is 0%, so the description must carry parameter meaning. It explains obj_name well and gives semantics for limit/offset ('page size and start index'), but the required doc_name parameter is never mentioned in the description, leaving a notable gap.

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+resource ('List a document's objects, or read one object's full properties') and clearly captures the dual-mode behavior. It doesn't explicitly reference siblings like list_documents, but the resource scope (objects within a document) 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 Guidelines4/5

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

Gives explicit conditional guidance for the dual mode: omit obj_name to list, pass a name to read. This is clear context for selecting behavior. It stops short of naming alternative tools or exclusions, keeping it at a 4 rather than 5.

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