Skip to main content
Glama

Get readiness finding

get_readiness_finding
Read-onlyIdempotent

One readiness check: why it matters, its drafted fix, and where it fails. Pass check_request_id to follow a verify_readiness_fix re-check.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
brandYesBrand or study: its ID from list_brands, or its name (exact or a unique prefix).
limitNoRows per page. Defaults to 25, max 100. A page may hold fewer rows to stay within the response size; follow next_cursor.
cursorNonext_cursor from the previous page. Leave out for the first page.
run_idNoOptional scan ID; defaults to the latest.
check_idYesCheck ID from get_readiness.
check_request_idNoOptional: the check_request_id from verify_readiness_fix, to include that re-check's status and result.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
generated_atYesRFC 3339 time the response was made.
schema_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / data / properties / instances / items / required
      Previous value: -[
      -  "url",
      -  "scope",
      -  "page_count",
      -  "current",
      -  "expected",
      -  "detail"
      -]New value: +[
      +  "scope",
      +  "page_count"
      +]
  2. Changed6 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / brand / minLength
      Added value: +1
    • addedInput schema / properties / check_id / minLength
      Added value: +1
    • changedInput schema / properties / cursor / description
      Previous value: -"next_cursor from the previous page."New value: +"next_cursor from the previous page. Leave out for the first page."
    • changedInput schema / properties / limit / description
      Previous value: -"Rows per page. Defaults to 25, max 100."New value: +"Rows per page. Defaults to 25, max 100. A page may hold fewer rows to stay within the response size; follow next_cursor."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "brand": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "id": {
      +              "type": "string"
      +            },
      +            "name": {
      +              "type": "string"
      +            },
      +            "url": {
      +              "description": "The brand's website, or empty when none is set.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "name",
      +            "url"
      +          ],
      +          "type": "object"
      +        },
      +        "check_request": {
      +          "additionalProperties": false,
      +          "description": "The re-check named by check_request_id.",
      +          "properties": {
      +            "check_id": {
      +              "type": "string"
      +            },
      +            "completed_at": {
      +              "type": "string"
      +            },
      +            "created_at": {
      +              "type": "string"
      +            },
      +            "error": {
      +              "type": "string"
      +            },
      +            "id": {
      +              "description": "The check_request_id get_readiness_finding takes.",
      +              "type": "string"
      +            },
      +            "per_url": {
      +              "items": {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "status": {
      +                    "type": "string"
      +                  },
      +                  "url": {
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "url",
      +                  "status"
      +                ],
      +                "type": "object"
      +              },
      +              "type": "array"
      +            },
      +            "recharges_at": {
      +              "description": "When the re-check's charge returns to the monthly allowance; empty when it used none.",
      +              "type": "string"
      +            },
      +            "resolved": {
      +              "description": "Whether the issue is fixed; null until complete.",
      +              "type": [
      +                "null",
      +                "boolean"
      +              ]
      +            },
      +            "status": {
      +              "description": "queued, processing, complete, or failed.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "check_id",
      +            "status",
      +            "resolved",
      +            "per_url",
      +            "error",
      +            "created_at",
      +            "completed_at",
      +            "recharges_at"
      +          ],
      +          "type": [
      +            "null",
      +            "object"
      +          ]
      +        },
      +        "finding": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "affected_pages": {
      +              "type": "integer"
      +            },
      +            "check_id": {
      +              "description": "Pass to get_readiness_finding or verify_readiness_fix.",
      +              "type": "string"
      +            },
      +            "consequence": {
      +              "type": "string"
      +            },
      +            "effort_minutes": {
      +              "type": [
      +                "null",
      +                "integer"
      +              ]
      +            },
      +            "fix_type": {
      +              "type": "string"
      +            },
      +            "label": {
      +              "type": "string"
      +            },
      +            "latest_check": {
      +              "additionalProperties": false,
      +              "description": "The latest re-check since the scan.",
      +              "properties": {
      +                "check_id": {
      +                  "type": "string"
      +                },
      +                "completed_at": {
      +                  "type": "string"
      +                },
      +                "created_at": {
      +                  "type": "string"
      +                },
      +                "error": {
      +                  "type": "string"
      +                },
      +                "id": {
      +                  "description": "The check_request_id get_readiness_finding takes.",
      +                  "type": "string"
      +                },
      +                "per_url": {
      +                  "items": {
      +                    "additionalProperties": false,
      +                    "properties": {
      +                      "status": {
      +                        "type": "string"
      +                      },
      +                      "url": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "required": [
      +                      "url",
      +                      "status"
      +                    ],
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "recharges_at": {
      +                  "description": "When the re-check's charge returns to the monthly allowance; empty when it used none.",
      +                  "type": "string"
      +                },
      +                "resolved": {
      +                  "description": "Whether the issue is fixed; null until complete.",
      +                  "type": [
      +                    "null",
      +                    "boolean"
      +                  ]
      +                },
      +                "status": {
      +                  "description": "queued, processing, complete, or failed.",
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "id",
      +                "check_id",
      +                "status",
      +                "resolved",
      +                "per_url",
      +                "error",
      +                "created_at",
      +                "completed_at",
      +                "recharges_at"
      +              ],
      +              "type": [
      +                "null",
      +                "object"
      +              ]
      +            },
      +            "owner_role": {
      +              "type": "string"
      +            },
      +            "pillar": {
      +              "type": "string"
      +            },
      +            "points_recoverable": {
      +              "type": "number"
      +            },
      +            "severity": {
      +              "description": "critical, major, minor, or info; empty when passing.",
      +              "type": "string"
      +            },
      +            "site_wide": {
      +              "description": "One fix applies to the whole site.",
      +              "type": "boolean"
      +            },
      +            "status": {
      +              "description": "fail, warning, pass, or not_applicable.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "check_id",
      +            "label",
      +            "pillar",
      +            "status",
      +            "severity",
      +            "consequence",
      +            "points_recoverable",
      +            "effort_minutes",
      +            "owner_role",
      +            "fix_type",
      +            "affected_pages",
      +            "site_wide",
      +            "latest_check"
      +          ],
      +          "type": "object"
      +        },
      +        "fix": {
      +          "additionalProperties": false,
      +          "description": "How to fix it; null when no fix is drafted.",
      +          "properties": {
      +            "applies_to": {
      +              "description": "Up to 10 of the URLs or paths the fix applies to.",
      +              "items": {
      +                "type": "string"
      +              },
      +              "type": "array"
      +            },
      +            "applies_to_total": {
      +              "type": "integer"
      +            },
      +            "content": {
      +              "type": "string"
      +            },
      +            "kind": {
      +              "type": "string"
      +            },
      +            "language": {
      +              "type": "string"
      +            },
      +            "notes": {
      +              "type": "string"
      +            },
      +            "title": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "kind",
      +            "title",
      +            "language",
      +            "content",
      +            "notes",
      +            "applies_to",
      +            "applies_to_total"
      +          ],
      +          "type": [
      +            "null",
      +            "object"
      +          ]
      +        },
      +        "instances": {
      +          "description": "Where the check fails.",
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "current": {
      +                "type": "string"
      +              },
      +              "detail": {
      +                "type": "string"
      +              },
      +              "expected": {
      +                "type": "string"
      +              },
      +              "page_count": {
      +                "type": "integer"
      +              },
      +              "scope": {
      +                "description": "page, template, or site.",
      +                "type": "string"
      +              },
      +              "url": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "url",
      +              "scope",
      +              "page_count",
      +              "current",
      +              "expected",
      +              "detail"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "pagination": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "next_cursor": {
      +              "description": "Pass as cursor to get the next page; empty on the last page.",
      +              "type": "string"
      +            },
      +            "total": {
      +              "description": "Items across all pages; null when not counted.",
      +              "type": [
      +                "null",
      +                "integer"
      +              ]
      +            }
      +          },
      +          "required": [
      +            "next_cursor",
      +            "total"
      +          ],
      +          "type": "object"
      +        },
      +        "scan_id": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "brand",
      +        "scan_id",
      +        "finding",
      +        "fix",
      +        "instances",
      +        "pagination",
      +        "check_request"
      +      ],
      +      "type": "object"
      +    },
      +    "generated_at": {
      +      "description": "RFC 3339 time the response was made.",
      +      "type": "string"
      +    },
      +    "schema_version": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "schema_version",
      +    "generated_at",
      +    "data"
      +  ],
      +  "type": "object"
      +}
  3. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered. The description adds the shape of the finding (rationale, fix, failure location), which is genuine context, but says nothing about permissions, scoping to run_id, or pagination behavior.

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?

Two tight sentences with no waste; the identifying content of the finding is front-loaded and the workflow hint follows immediately.

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 an output schema present, return values need no explanation, and the description covers the tool's content and its link to verify_readiness_fix. It is nearly complete, though the relationship to get_readiness and run_id scoping could be clearer.

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 description coverage is 100%, so brand, check_id, run_id, limit and cursor are already documented in the schema. The description only touches check_request_id, and even that repeats the schema text, so it adds little beyond structured data — baseline 3.

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 names a specific resource ('one readiness check') and enumerates its contents (why it matters, drafted fix, where it fails), which distinguishes it from get_readiness (a list) and verify_readiness_fix (a re-check). It does not explicitly contrast itself with those siblings, keeping it short of a 5.

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?

It implies the follow-up workflow by stating 'Pass check_request_id to follow a verify_readiness_fix re-check', which is useful routing context. However, it never says when to call this versus get_readiness, nor any exclusion or prerequisite, so usage is only implied.

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