Skip to main content
Glama
Sign In
kompas3d

kompas3d

by hymaxo
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

set_entity_state

Rename, hide/show, or suppress/restore a native entity in a KOMPAS-3D model and rebuild the document to apply changes.

Instructions

Rename, hide/show, or suppress/restore a native entity and rebuild.

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": {
      "document_id": "<document_id>",
      "entity_id": "<entity_id>"
    },
    "name": "set_entity_state"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
hiddenNo
excludedNo
entity_idYes
document_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.8/5.0
Behavior2/5

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

With no annotations, the description carries the disclosure burden. It discloses that the action mutates entity state and rebuilds, but does not explain side effects, reversibility, permissions required, or the consequences of suppression/restoration beyond the rebuild.

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 no filler. Every phrase adds operational information and the format is easy to scan.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has no annotations, no output schema, and 0% schema coverage, yet the description does not cover return values, prerequisites, relationship among parameters, or operational risks. Too sparse to give an agent enough context for a mutating CAD operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate. The verbs 'rename', 'hide/show', and 'suppress/restore' loosely map to the name, hidden, and excluded parameters, but the required document_id and entity_id are not explained, and null/default semantics and parameter interactions are undocumented.

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?

The description names specific operations (rename, hide/show, suppress/restore) and a clear resource ('native entity'), followed by the rebuild side effect. It is distinct from siblings like set_variable or set_material, though it does not explicitly contrast itself with update_feature or delete_feature.

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 use this tool versus alternatives such as update_feature, delete_feature, or list_entities. The description lists what it can do but does not state the context, prerequisites, or when-not-to-use conditions.

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