Skip to main content
Glama

GetObjectsByType

Lists objects of a specified type, such as classes, tables, programs, or interfaces, under a package or composite object using its node ID and parent details.

Instructions

[read-only] Lists the objects of one type (classes, tables, programs, interfaces, etc.), the type whose node in the object tree is named by node_id, under the package or composite object named by parent_name, parent_tech_name and parent_type. Recordable: in batch mode a call is recorded under the next number and answers with empty content; its answer is read by number after the batch ends.

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": {
      "parent_name": "<parent_name>",
      "parent_tech_name": "<parent_tech_name>",
      "parent_type": "<parent_type>",
      "node_id": "<node_id>"
    },
    "name": "GetObjectsByType"
  }
}

Input Schema

NameRequiredDescriptionDefault
formatNo[read-only] Output format: 'parsed' (default). 'raw' is accepted for backward compatibility but answers the same parsed text — see the note on `nodeLevel` below.
node_idYes[read-only] Node ID
parent_nameYes[read-only] Parent object name
parent_typeYes[read-only] Parent object type
parent_tech_nameYes[read-only] Parent technical name
with_short_descriptionsNo[read-only] Include short descriptions

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv16.0.0
    • changedInput schema / properties / format / description
      Previous value: -"[read-only] Output format: 'raw' or 'parsed'"New value: +"[read-only] Output format: 'parsed' (default). 'raw' is accepted for backward compatibility but answers the same parsed text — see the note on `nodeLevel` below."
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full disclosure burden. It does add a valuable non-obvious trait: in batch mode the call is recorded under the next number and returns empty content, with the answer retrieved by number afterward. However, it says nothing about error behavior, permissions, result size, or how the returned list is shaped.

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?

Front-loaded with the read-only marker and the core verb+resource, followed by a single dense sentence that defines the addressing scheme and a second that covers batch recording. Every clause carries information; nothing is padding.

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?

For a 6-parameter read tool with no annotations and no output schema, the description covers purpose, addressing, and batch semantics but never indicates what the returned object list contains or how large it may be. It is adequate to invoke correctly, but not complete for interpreting results.

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 100%, which sets the baseline at 3, but the description genuinely adds meaning: it explains that node_id names the type's node in the object tree and that parent_name/parent_tech_name/parent_type identify the enclosing package or composite object, which the flat schema labels ('Node ID', 'Parent object name') do 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: lists objects of one type (classes, tables, programs, interfaces) and explains the identification path (the type node named by node_id under the package/composite object). The purpose is clear, though it never names sibling tools like GetObjectsList, GetPackageContents, or GetLocalTypes, so differentiation must be inferred from the hierarchical node+parent addressing.

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 explains which identifiers are needed (node_id plus the parent trio) but gives no explicit when-to-use or when-not-to-use guidance, and no alternatives are mentioned despite several overlapping list tools among the siblings. Batch-mode recording is described, but that is behavior, not selection guidance.

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