Skip to main content
Glama

Check Codex readiness (free)

codex_status
Read-only

Check Codex CLI setup and live quota to confirm readiness before paid calls. Reports installation, authentication, version, and rate-limit status to guide spending.

Instructions

Check that the codex CLI is installed, authenticated, and a supported version, and report the resolved defaults. Free — no model call. Run it before your first paid call in a session to confirm setup, and again whenever a run fails with a setup error. Also reports a rate_limit block — how much of the Codex quota windows remains, fetched LIVE from codex app-server (a read-only call with no model spend). primary is the shorter/rolling window, secondary the longer one; the account reports only the windows that currently bind it, so either may be null. Use it to decide whether to spend: available is deliberately conservative (only when every reported window is healthy); when limited/exhausted, prefer to defer non-urgent Codex calls (urgent ones may still proceed); unknown means the live read couldn't complete just now (retry) or only a stale cache was available; unavailable means this codex/account exposes no quota data — none of these means anything is wrong. blocked is different: the backend reports a SPEND control (spend_control_reached: true), so paid calls will fail and waiting for a quota reset will NOT clear it — don't defer, and surface it to the user. spend_control_reached is null when this codex/backend didn't report that state (then available covers the quota windows only, and note says so). is_stale/as_of show freshness; home_unverified flags a snapshot from a different CODEX_HOME.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed1 schema field changedv0.19.0
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "auth_detail": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "caveat": {
      -        "type": "string"
      -      },
      -      "codex_authenticated": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "codex_found": {
      -        "type": "boolean"
      -      },
      -      "codex_version": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "extra_args_configured": {
      -        "type": "boolean"
      -      },
      -      "extra_args_count": {
      -        "type": "integer"
      -      },
      -      "extra_args_valid": {
      -        "type": "boolean"
      -      },
      -      "fingerprint": {
      -        "type": "string"
      -      },
      -      "flags_warning": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "ok": {
      -        "const": true,
      -        "type": "boolean"
      -      },
      -      "rate_limit": {
      -        "description": "Codex rate-limit snapshot; full schema at resource codex://status-result",
      -        "type": "object"
      -      },
      -      "raw_defaults": {
      -        "description": "Raw configured defaults; full schema at resource codex://status-result",
      -        "type": "object"
      -      },
      -      "readiness_detail": {
      -        "type": "string"
      -      },
      -      "ready": {
      -        "type": "boolean"
      -      },
      -      "resolved_defaults": {
      -        "description": "Resolved effective defaults; full schema at resource codex://status-result",
      -        "type": "object"
      -      },
      -      "server_version": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "version_supported": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "version_warning": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "codex_found",
      -      "readiness_detail",
      -      "raw_defaults",
      -      "resolved_defaults",
      -      "caveat"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "error": {
      -        "description": "Populated error envelope; full schema at resource codex://error-envelope",
      -        "type": "object"
      -      },
      -      "meta": {
      -        "type": "object"
      -      },
      -      "ok": {
      -        "const": false
      -      }
      -    },
      -    "required": [
      -      "ok",
      -      "error",
      -      "meta"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "auth_detail": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "caveat": {
      +        "type": "string"
      +      },
      +      "codex_authenticated": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "codex_found": {
      +        "type": "boolean"
      +      },
      +      "codex_version": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "description": "Display copy of `codex --version`: control characters removed, secret-looking values redacted, clipped to 200 characters with a trailing advisory `…[truncated]`; null if codex did not run or nothing printable remained. Do not parse it — `version_supported` is the verdict, and it is parsed from the raw output, which can differ from this."
      +      },
      +      "extra_args_configured": {
      +        "type": "boolean"
      +      },
      +      "extra_args_count": {
      +        "type": "integer"
      +      },
      +      "extra_args_valid": {
      +        "type": "boolean"
      +      },
      +      "fingerprint": {
      +        "type": "string"
      +      },
      +      "flags_warning": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "ok": {
      +        "const": true,
      +        "type": "boolean"
      +      },
      +      "rate_limit": {
      +        "description": "Codex rate-limit snapshot; full schema at resource codex://status-result",
      +        "type": "object"
      +      },
      +      "raw_defaults": {
      +        "description": "Raw configured defaults; full schema at resource codex://status-result",
      +        "type": "object"
      +      },
      +      "readiness_detail": {
      +        "type": "string"
      +      },
      +      "ready": {
      +        "type": "boolean"
      +      },
      +      "resolved_defaults": {
      +        "description": "Resolved effective defaults; full schema at resource codex://status-result",
      +        "type": "object"
      +      },
      +      "server_version": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "version_supported": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "version_warning": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "codex_found",
      +      "readiness_detail",
      +      "raw_defaults",
      +      "resolved_defaults",
      +      "caveat"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "error": {
      +        "description": "Populated error envelope; full schema at resource codex://error-envelope",
      +        "type": "object"
      +      },
      +      "meta": {
      +        "type": "object"
      +      },
      +      "ok": {
      +        "const": false
      +      }
      +    },
      +    "required": [
      +      "ok",
      +      "error",
      +      "meta"
      +    ],
      +    "type": "object"
      +  }
      +]
  2. Changed1 schema field changedv0.11.0
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "auth_detail": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "caveat": {
      -        "type": "string"
      -      },
      -      "codex_authenticated": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "codex_found": {
      -        "type": "boolean"
      -      },
      -      "codex_version": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "extra_args_configured": {
      -        "type": "boolean"
      -      },
      -      "extra_args_count": {
      -        "type": "integer"
      -      },
      -      "extra_args_valid": {
      -        "type": "boolean"
      -      },
      -      "fingerprint": {
      -        "type": "string"
      -      },
      -      "flags_warning": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "ok": {
      -        "const": true,
      -        "type": "boolean"
      -      },
      -      "rate_limit": {
      -        "description": "Codex rate-limit snapshot; full schema at resource codex://status-result",
      -        "type": "object"
      -      },
      -      "raw_defaults": {
      -        "description": "Raw configured defaults; full schema at resource codex://status-result",
      -        "type": "object"
      -      },
      -      "readiness_detail": {
      -        "type": "string"
      -      },
      -      "ready": {
      -        "type": "boolean"
      -      },
      -      "resolved_defaults": {
      -        "description": "Resolved effective defaults; full schema at resource codex://status-result",
      -        "type": "object"
      -      },
      -      "version_supported": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "version_warning": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "codex_found",
      -      "readiness_detail",
      -      "raw_defaults",
      -      "resolved_defaults",
      -      "caveat"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "error": {
      -        "description": "Populated error envelope; full schema at resource codex://error-envelope",
      -        "type": "object"
      -      },
      -      "meta": {
      -        "type": "object"
      -      },
      -      "ok": {
      -        "const": false
      -      }
      -    },
      -    "required": [
      -      "ok",
      -      "error",
      -      "meta"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "auth_detail": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "caveat": {
      +        "type": "string"
      +      },
      +      "codex_authenticated": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "codex_found": {
      +        "type": "boolean"
      +      },
      +      "codex_version": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "extra_args_configured": {
      +        "type": "boolean"
      +      },
      +      "extra_args_count": {
      +        "type": "integer"
      +      },
      +      "extra_args_valid": {
      +        "type": "boolean"
      +      },
      +      "fingerprint": {
      +        "type": "string"
      +      },
      +      "flags_warning": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "ok": {
      +        "const": true,
      +        "type": "boolean"
      +      },
      +      "rate_limit": {
      +        "description": "Codex rate-limit snapshot; full schema at resource codex://status-result",
      +        "type": "object"
      +      },
      +      "raw_defaults": {
      +        "description": "Raw configured defaults; full schema at resource codex://status-result",
      +        "type": "object"
      +      },
      +      "readiness_detail": {
      +        "type": "string"
      +      },
      +      "ready": {
      +        "type": "boolean"
      +      },
      +      "resolved_defaults": {
      +        "description": "Resolved effective defaults; full schema at resource codex://status-result",
      +        "type": "object"
      +      },
      +      "server_version": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "version_supported": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "version_warning": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "codex_found",
      +      "readiness_detail",
      +      "raw_defaults",
      +      "resolved_defaults",
      +      "caveat"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "error": {
      +        "description": "Populated error envelope; full schema at resource codex://error-envelope",
      +        "type": "object"
      +      },
      +      "meta": {
      +        "type": "object"
      +      },
      +      "ok": {
      +        "const": false
      +      }
      +    },
      +    "required": [
      +      "ok",
      +      "error",
      +      "meta"
      +    ],
      +    "type": "object"
      +  }
      +]
  3. Changed1 schema field changedv0.9.0
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "auth_detail": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "caveat": {
      -        "type": "string"
      -      },
      -      "codex_authenticated": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "codex_found": {
      -        "type": "boolean"
      -      },
      -      "codex_version": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "fingerprint": {
      -        "type": "string"
      -      },
      -      "flags_warning": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "ok": {
      -        "const": true,
      -        "type": "boolean"
      -      },
      -      "rate_limit": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "age_seconds": {
      -            "anyOf": [
      -              {
      -                "type": "integer"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "as_of": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "home_unverified": {
      -            "type": "boolean"
      -          },
      -          "is_stale": {
      -            "type": "boolean"
      -          },
      -          "limiting_window": {
      -            "anyOf": [
      -              {
      -                "enum": [
      -                  "primary",
      -                  "secondary"
      -                ],
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "note": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "plan_type": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "primary": {
      -            "anyOf": [
      -              {
      -                "additionalProperties": false,
      -                "properties": {
      -                  "remaining_percent": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "reset_passed": {
      -                    "type": "boolean"
      -                  },
      -                  "resets_at": {
      -                    "anyOf": [
      -                      {
      -                        "type": "string"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "seconds_until_reset": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "used_percent": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "window_minutes": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  }
      -                },
      -                "type": "object"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "secondary": {
      -            "anyOf": [
      -              {
      -                "additionalProperties": false,
      -                "properties": {
      -                  "remaining_percent": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "reset_passed": {
      -                    "type": "boolean"
      -                  },
      -                  "resets_at": {
      -                    "anyOf": [
      -                      {
      -                        "type": "string"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "seconds_until_reset": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "used_percent": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "window_minutes": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  }
      -                },
      -                "type": "object"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "source": {
      -            "enum": [
      -              "current_run",
      -              "plugin_cache"
      -            ],
      -            "type": "string"
      -          },
      -          "status": {
      -            "enum": [
      -              "available",
      -              "limited",
      -              "exhausted",
      -              "unknown"
      -            ],
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "status"
      -        ],
      -        "type": "object"
      -      },
      -      "raw_defaults": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "isolation": {
      -            "type": "string"
      -          },
      -          "model": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "sandbox": {
      -            "type": "string"
      -          },
      -          "tier": {
      -            "type": "string"
      -          },
      -          "timeout_seconds": {
      -            "type": "integer"
      -          }
      -        },
      -        "required": [
      -          "tier",
      -          "sandbox",
      -          "isolation",
      -          "timeout_seconds"
      -        ],
      -        "type": "object"
      -      },
      -      "readiness_detail": {
      -        "type": "string"
      -      },
      -      "ready": {
      -        "type": "boolean"
      -      },
      -      "resolved_defaults": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "isolation": {
      -            "enum": [
      -              "inherit",
      -              "ignore-config",
      -              "ignore-rules"
      -            ],
      -            "type": "string"
      -          },
      -          "model": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "sandbox": {
      -            "enum": [
      -              "read-only",
      -              "workspace-write",
      -              "danger-full-access"
      -            ],
      -            "type": "string"
      -          },
      -          "tier": {
      -            "enum": [
      -              "consult",
      -              "propose",
      -              "apply"
      -            ],
      -            "type": "string"
      -          },
      -          "timeout_bounds": {
      -            "items": {
      -              "type": "integer"
      -            },
      -            "type": "array"
      -          },
      -          "timeout_seconds": {
      -            "type": "integer"
      -          }
      -        },
      -        "required": [
      -          "tier",
      -          "sandbox",
      -          "isolation",
      -          "timeout_seconds",
      -          "timeout_bounds"
      -        ],
      -        "type": "object"
      -      },
      -      "version_supported": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "version_warning": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "codex_found",
      -      "readiness_detail",
      -      "raw_defaults",
      -      "resolved_defaults",
      -      "caveat"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "error": {
      -        "description": "Populated error envelope; full schema at resource codex://error-envelope",
      -        "type": "object"
      -      },
      -      "meta": {
      -        "type": "object"
      -      },
      -      "ok": {
      -        "const": false
      -      }
      -    },
      -    "required": [
      -      "ok",
      -      "error",
      -      "meta"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "auth_detail": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "caveat": {
      +        "type": "string"
      +      },
      +      "codex_authenticated": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "codex_found": {
      +        "type": "boolean"
      +      },
      +      "codex_version": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "extra_args_configured": {
      +        "type": "boolean"
      +      },
      +      "extra_args_count": {
      +        "type": "integer"
      +      },
      +      "extra_args_valid": {
      +        "type": "boolean"
      +      },
      +      "fingerprint": {
      +        "type": "string"
      +      },
      +      "flags_warning": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "ok": {
      +        "const": true,
      +        "type": "boolean"
      +      },
      +      "rate_limit": {
      +        "description": "Codex rate-limit snapshot; full schema at resource codex://status-result",
      +        "type": "object"
      +      },
      +      "raw_defaults": {
      +        "description": "Raw configured defaults; full schema at resource codex://status-result",
      +        "type": "object"
      +      },
      +      "readiness_detail": {
      +        "type": "string"
      +      },
      +      "ready": {
      +        "type": "boolean"
      +      },
      +      "resolved_defaults": {
      +        "description": "Resolved effective defaults; full schema at resource codex://status-result",
      +        "type": "object"
      +      },
      +      "version_supported": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "version_warning": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "codex_found",
      +      "readiness_detail",
      +      "raw_defaults",
      +      "resolved_defaults",
      +      "caveat"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "error": {
      +        "description": "Populated error envelope; full schema at resource codex://error-envelope",
      +        "type": "object"
      +      },
      +      "meta": {
      +        "type": "object"
      +      },
      +      "ok": {
      +        "const": false
      +      }
      +    },
      +    "required": [
      +      "ok",
      +      "error",
      +      "meta"
      +    ],
      +    "type": "object"
      +  }
      +]
  4. Changed2 schema fields changedv0.8.0
    • addedOutput schema / $schema
      Added value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "auth_detail": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "caveat": {
      -        "type": "string"
      -      },
      -      "codex_authenticated": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "codex_found": {
      -        "type": "boolean"
      -      },
      -      "codex_version": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "fingerprint": {
      -        "type": "string"
      -      },
      -      "flags_warning": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "ok": {
      -        "const": true,
      -        "type": "boolean"
      -      },
      -      "rate_limit": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "age_seconds": {
      -            "anyOf": [
      -              {
      -                "type": "integer"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "as_of": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "home_unverified": {
      -            "type": "boolean"
      -          },
      -          "is_stale": {
      -            "type": "boolean"
      -          },
      -          "limiting_window": {
      -            "anyOf": [
      -              {
      -                "enum": [
      -                  "primary",
      -                  "secondary"
      -                ],
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "note": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "plan_type": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "primary": {
      -            "anyOf": [
      -              {
      -                "additionalProperties": false,
      -                "properties": {
      -                  "remaining_percent": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "reset_passed": {
      -                    "type": "boolean"
      -                  },
      -                  "resets_at": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "seconds_until_reset": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "used_percent": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "window_minutes": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  }
      -                },
      -                "type": "object"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "secondary": {
      -            "anyOf": [
      -              {
      -                "additionalProperties": false,
      -                "properties": {
      -                  "remaining_percent": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "reset_passed": {
      -                    "type": "boolean"
      -                  },
      -                  "resets_at": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "seconds_until_reset": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "used_percent": {
      -                    "anyOf": [
      -                      {
      -                        "type": "number"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  },
      -                  "window_minutes": {
      -                    "anyOf": [
      -                      {
      -                        "type": "integer"
      -                      },
      -                      {
      -                        "type": "null"
      -                      }
      -                    ]
      -                  }
      -                },
      -                "type": "object"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "source": {
      -            "enum": [
      -              "current_run",
      -              "plugin_cache"
      -            ],
      -            "type": "string"
      -          },
      -          "status": {
      -            "enum": [
      -              "available",
      -              "limited",
      -              "exhausted",
      -              "unknown"
      -            ],
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "status"
      -        ],
      -        "type": "object"
      -      },
      -      "raw_defaults": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "isolation": {
      -            "type": "string"
      -          },
      -          "model": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "sandbox": {
      -            "type": "string"
      -          },
      -          "tier": {
      -            "type": "string"
      -          },
      -          "timeout_seconds": {
      -            "type": "integer"
      -          }
      -        },
      -        "required": [
      -          "tier",
      -          "sandbox",
      -          "isolation",
      -          "timeout_seconds"
      -        ],
      -        "type": "object"
      -      },
      -      "readiness_detail": {
      -        "type": "string"
      -      },
      -      "ready": {
      -        "type": "boolean"
      -      },
      -      "resolved_defaults": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "isolation": {
      -            "enum": [
      -              "inherit",
      -              "ignore-config",
      -              "ignore-rules"
      -            ],
      -            "type": "string"
      -          },
      -          "model": {
      -            "anyOf": [
      -              {
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ]
      -          },
      -          "sandbox": {
      -            "enum": [
      -              "read-only",
      -              "workspace-write",
      -              "danger-full-access"
      -            ],
      -            "type": "string"
      -          },
      -          "tier": {
      -            "enum": [
      -              "consult",
      -              "propose",
      -              "apply"
      -            ],
      -            "type": "string"
      -          },
      -          "timeout_bounds": {
      -            "items": {
      -              "type": "integer"
      -            },
      -            "type": "array"
      -          },
      -          "timeout_seconds": {
      -            "type": "integer"
      -          }
      -        },
      -        "required": [
      -          "tier",
      -          "sandbox",
      -          "isolation",
      -          "timeout_seconds",
      -          "timeout_bounds"
      -        ],
      -        "type": "object"
      -      },
      -      "version_supported": {
      -        "anyOf": [
      -          {
      -            "type": "boolean"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "version_warning": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "codex_found",
      -      "readiness_detail",
      -      "raw_defaults",
      -      "resolved_defaults",
      -      "caveat"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "error": {
      -        "description": "Populated error envelope; full schema at resource codex://error-envelope",
      -        "type": "object"
      -      },
      -      "meta": {
      -        "type": "object"
      -      },
      -      "ok": {
      -        "const": false
      -      }
      -    },
      -    "required": [
      -      "ok",
      -      "error",
      -      "meta"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "auth_detail": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "caveat": {
      +        "type": "string"
      +      },
      +      "codex_authenticated": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "codex_found": {
      +        "type": "boolean"
      +      },
      +      "codex_version": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "fingerprint": {
      +        "type": "string"
      +      },
      +      "flags_warning": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "ok": {
      +        "const": true,
      +        "type": "boolean"
      +      },
      +      "rate_limit": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "age_seconds": {
      +            "anyOf": [
      +              {
      +                "type": "integer"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "as_of": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "home_unverified": {
      +            "type": "boolean"
      +          },
      +          "is_stale": {
      +            "type": "boolean"
      +          },
      +          "limiting_window": {
      +            "anyOf": [
      +              {
      +                "enum": [
      +                  "primary",
      +                  "secondary"
      +                ],
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "note": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "plan_type": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "primary": {
      +            "anyOf": [
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "remaining_percent": {
      +                    "anyOf": [
      +                      {
      +                        "type": "number"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "reset_passed": {
      +                    "type": "boolean"
      +                  },
      +                  "resets_at": {
      +                    "anyOf": [
      +                      {
      +                        "type": "string"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "seconds_until_reset": {
      +                    "anyOf": [
      +                      {
      +                        "type": "integer"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "used_percent": {
      +                    "anyOf": [
      +                      {
      +                        "type": "number"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "window_minutes": {
      +                    "anyOf": [
      +                      {
      +                        "type": "integer"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "secondary": {
      +            "anyOf": [
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "remaining_percent": {
      +                    "anyOf": [
      +                      {
      +                        "type": "number"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "reset_passed": {
      +                    "type": "boolean"
      +                  },
      +                  "resets_at": {
      +                    "anyOf": [
      +                      {
      +                        "type": "string"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "seconds_until_reset": {
      +                    "anyOf": [
      +                      {
      +                        "type": "integer"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "used_percent": {
      +                    "anyOf": [
      +                      {
      +                        "type": "number"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  },
      +                  "window_minutes": {
      +                    "anyOf": [
      +                      {
      +                        "type": "integer"
      +                      },
      +                      {
      +                        "type": "null"
      +                      }
      +                    ]
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "source": {
      +            "enum": [
      +              "current_run",
      +              "plugin_cache"
      +            ],
      +            "type": "string"
      +          },
      +          "status": {
      +            "enum": [
      +              "available",
      +              "limited",
      +              "exhausted",
      +              "unknown"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "status"
      +        ],
      +        "type": "object"
      +      },
      +      "raw_defaults": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "isolation": {
      +            "type": "string"
      +          },
      +          "model": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "sandbox": {
      +            "type": "string"
      +          },
      +          "tier": {
      +            "type": "string"
      +          },
      +          "timeout_seconds": {
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "tier",
      +          "sandbox",
      +          "isolation",
      +          "timeout_seconds"
      +        ],
      +        "type": "object"
      +      },
      +      "readiness_detail": {
      +        "type": "string"
      +      },
      +      "ready": {
      +        "type": "boolean"
      +      },
      +      "resolved_defaults": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "isolation": {
      +            "enum": [
      +              "inherit",
      +              "ignore-config",
      +              "ignore-rules"
      +            ],
      +            "type": "string"
      +          },
      +          "model": {
      +            "anyOf": [
      +              {
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ]
      +          },
      +          "sandbox": {
      +            "enum": [
      +              "read-only",
      +              "workspace-write",
      +              "danger-full-access"
      +            ],
      +            "type": "string"
      +          },
      +          "tier": {
      +            "enum": [
      +              "consult",
      +              "propose",
      +              "apply"
      +            ],
      +            "type": "string"
      +          },
      +          "timeout_bounds": {
      +            "items": {
      +              "type": "integer"
      +            },
      +            "type": "array"
      +          },
      +          "timeout_seconds": {
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "tier",
      +          "sandbox",
      +          "isolation",
      +          "timeout_seconds",
      +          "timeout_bounds"
      +        ],
      +        "type": "object"
      +      },
      +      "version_supported": {
      +        "anyOf": [
      +          {
      +            "type": "boolean"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "version_warning": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "codex_found",
      +      "readiness_detail",
      +      "raw_defaults",
      +      "resolved_defaults",
      +      "caveat"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "error": {
      +        "description": "Populated error envelope; full schema at resource codex://error-envelope",
      +        "type": "object"
      +      },
      +      "meta": {
      +        "type": "object"
      +      },
      +      "ok": {
      +        "const": false
      +      }
      +    },
      +    "required": [
      +      "ok",
      +      "error",
      +      "meta"
      +    ],
      +    "type": "object"
      +  }
      +]
  5. First observedv0.5.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only carry readOnlyHint, but the description goes deep: it discloses the live `codex app-server` fetch, the no-model-spend property, the conservative `available` semantics, the stale-cache fallback, and — most valuably — the critical distinction between benign states (`unknown`/`unavailable`/`blocked`) and the `spend_control_reached` flag that means paid calls will fail and deferral won't help. This is exactly the behavioral nuance an agent cannot infer from a schema.

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?

The description is front-loaded — purpose and cost in the first two sentences — and every sentence earns its place, since the entire quota state machine needs explaining. It loses one point because the middle section is a dense, run-on paragraph that could be restructured (e.g., enumerating the field values) for easier scanning.

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?

Given an empty schema and readOnly annotations, the description is the entire contract, and it covers everything: installation/auth/version checks, quota window semantics and nullability, failure modes (retry vs. surface), and freshness fields (is_stale/as_of/home_unverified). An agent has everything needed to invoke the tool and interpret every plausible response state.

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?

With zero parameters and 100% schema coverage, there is nothing for the description to explain, so the per-rubric baseline of 4 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?

The description states a specific verb and resource — "Check that the codex CLI is installed, authenticated, and a supported version, and report the resolved defaults" — and immediately flags the differentiator from its siblings: "Free — no model call." This lets an agent distinguish the tool from model-spending siblings like codex_consult or codex_delegate, which is critical on a list full of async/dry-run variants.

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

Usage Guidelines5/5

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

The description gives explicit timing direction — "Run it before your first paid call in a session... and again whenever a run fails with a setup error" — and then defines a decision protocol: defer non-urgent calls when limited/exhausted, retry on unknown, surface blocked to the user ("don't defer"). This effectively covers both when-to-use and when-not-to-proceed, which for a status/health tool is the behavior that matters.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/briandconnelly/codex-in-claude'

If you have feedback or need assistance with the MCP directory API, please join our Discord server