Skip to main content
Glama

What an app still needs on a GraphQL API

app_readiness
Read-only

Checks what an API for GraphQL item still needs before an app can use it: types without a key or relationship, write access, introspection (one probe query), and permissions, reported as unknown with the portal path. Requires workspace and an API that create_backend has created. Returns JSON {api, endpoint, checks, missing, unknown, verdict}, each item with its next step. Changes nothing. Errors: {error, kind, hint}.

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": {
      "workspace": "<workspace>",
      "api": "<api>"
    },
    "name": "app_readiness"
  }
}

Input Schema

NameRequiredDescriptionDefault
apiYesAPI for GraphQL item created by create_backend, by name or id.
workspaceYesFabric workspace, name or id.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / api / description
      Added value: +"API for GraphQL item created by create_backend, by name or id."
    • addedInput schema / properties / workspace / description
      Added value: +"Fabric workspace, name or id."
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/destructiveHint, but the description adds real context beyond them: it discloses that one live introspection probe query is executed (relevant given openWorldHint=true), that unreachable checks are reported as 'unknown' with a portal path, and it specifies the error envelope {error, kind, hint}. That is meaningful behavioral disclosure, though it doesn't cover rate limiting or probe failure behavior in depth.

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?

Purpose and the required-check list are front-loaded, followed by prerequisites, return shape, and side effects in a tight sequence. The first sentence is dense with embedded lists, but nearly every clause carries information an agent would otherwise have to infer.

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

Completeness5/5

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

Covers what it checks, prerequisites, the fact that it changes nothing, and the error shape, all for a two-parameter read-only tool. The return-value summary is partly redundant with the existing output schema but not harmful; nothing an agent needs to invoke it correctly is missing.

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?

Schema coverage is 100% and both parameters are already documented, including the 'created by create_backend' constraint on api. The description restates the same requirement ('Requires workspace and an API that create_backend has created') without adding name-vs-id or format guidance, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('checks what an API for GraphQL item still needs before an app can use it') and enumerates the concrete checks performed: keyless types, relationships, write access, introspection, permissions. An agent can distinguish this from describe_backend or analyze_schema without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear precondition chain by naming the sibling that must run first ('an API that create_backend has created') and the lifecycle moment (before an app can use it). It stops short of explicit exclusions or a direct 'use X instead when...' comparison with siblings like app_starter or describe_backend.

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.