Skip to main content
Glama

get-schema

Get a complete schema definition showing properties, types, and constraints for Sage Intacct objects to build valid API payloads.

Instructions

Get detailed schema definition including all properties, types, and constraints. Example: schemaName=general-ledger-account

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
schemaNameYesName of the schema (e.g., general-ledger-account)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/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 behavioral burden. It states the returned content but does not explicitly declare read-only behavior, error cases, or response format. Acceptable for a simple retrieval tool, but not comprehensive.

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?

One concise sentence plus a concrete example. The action and result are front-loaded with no wasted words.

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?

With a single required parameter and no output schema, the description adequately specifies what the agent will receive (properties, types, constraints) and how to call it. It lacks explicit details about edge cases or output structure, but is sufficient for correct invocation.

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?

The input schema already documents schemaName with a full description and example at 100% coverage. The description's example adds little beyond what the schema provides, so the baseline of 3 applies.

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?

Clearly identifies a specific verb ('Get'), resource ('schema definition'), and content ('all properties, types, and constraints'). It does not explicitly contrast with sibling tools like list-schemas, but 'detailed schema definition' implies a distinction.

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?

Implied usage is clear: call this when you need the full schema definition. It does not explicitly state when to avoid it or mention alternatives such as list-schemas.

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