Skip to main content
Glama

data-api-code

graphql_schema_inspect

Parse a GraphQL SDL schema or introspection JSON to inventory Types, Queries, Mutations, Subscriptions, Enums, and Input types.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "graphql_schema_inspect"
  }
}

Input Schema

NameRequiredDescriptionDefault
textNo
filePathNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden. It discloses the output categories but says nothing about read-only/non-destructive nature, behavior on malformed SDL or invalid introspection JSON, or what happens when both input modes are supplied.

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?

A single front-loaded sentence with no filler; the verb and resource come first and the enumerated output types follow. The list of six construct types is slightly dense but each item is informative.

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?

With no output schema, the description does a reasonable job naming what the inventory contains. However, for a two-mode input tool with no annotations and no parameter documentation, the missing explanation of input modes and failure behavior leaves real gaps.

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% for both parameters, and the description never mentions "text" or "filePath". An agent must guess that one is inline SDL and the other a filesystem path, and with zero required parameters it cannot tell whether one is mandatory or which wins if both are given.

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 ("Parse") and a specific resource ("GraphQL SDL schema or introspection JSON") plus the resulting inventory categories. It is clearly distinguishable from graphql_query_build_and_validate and openapi_spec_inspect by resource type, though it never names an alternative explicitly.

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?

Usage is only implied: you have a schema and want an inventory of its constructs. There is no statement of when to prefer this over the sibling query-builder or spec-inspect tools, and no exclusions or prerequisites.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources