Skip to main content
Glama
Sign In
kompas3d

kompas3d

by hymaxo
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

api_describe_interface

Get KOMPAS-3D interface schemas by library and interface name without creating an object first. Discover available methods and properties to write valid API calls.

Instructions

Get schema for any installed interface without needing an object of that type first.

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": {
      "library": "<library>",
      "interface": "<interface>"
    },
    "name": "api_describe_interface"
  }
}

Input Schema

NameRequiredDescriptionDefault
libraryYes
interfaceYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral disclosure burden. It adds the useful context that no prior object is required, but it doesn't state that the operation is read-only, describe the return format, or mention error conditions for unknown interface names.

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 sentence that is front-loaded with the action and includes a key differentiator. No filler or redundant phrasing.

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?

For a tool with no annotations and no output schema, the description is too sparse. An agent lacks information about how the schema is returned, what library values imply, and what happens if the interface is not found.

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 description coverage is 0%, so the description must explain parameters, but it only clarifies 'interface' indirectly as 'installed interface'. It does not explain valid interface name formats or how library choices affect behavior, leaving the interface parameter underdocumented.

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 uses a specific verb 'Get' and a specific resource 'schema for any installed interface', clearly identifying the tool's function. It contrasts with sibling api_describe by focusing on interfaces and the no-object-needed advantage, though it does not explicitly name alternatives.

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 description implies when to use it: when you need an interface schema without first having an object. However, it offers no explicit comparison to sibling tools such as api_describe or api_invoke, and no conditions for when not to use it.

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