Skip to main content
Glama
Sign In

Phare

by io.phare.mcp
OverviewDiscussionsAdmin

Get a status page

get_status_page
Read-onlyIdempotent

Get the settings of a status page by ID, with its components. The status it shows is returned by its current status.

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": {
      "project_id": "<project_id>",
      "status_page_id": "<status_page_id>"
    },
    "name": "get_status_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idYesID of the project to act on, see whoami
status_page_idYesID of the status page to show

Output Schema

NameRequiredDescriptionDefault
idNoStatus page ID
nameNoStatus page name
tagsNoResource tags, made of lowercase letters, numbers, `.`, `_`, `:` and `-`. An organization can have up to 200 tags.
themeNoTheme settings to customize the status page
titleNoStatus page HTML title
domainNoCustom domain name for the status page
timezoneNoTimezone used to split the status page timeline into days and to display all dates on the status page and in feeds. Must be a canonical IANA timezone identifier (case-sensitive, e.g. `Europe/Paris`, `America/New_York` or `UTC`).UTC
subdomainNoSubdomain name for the status page, hosted on a phare.io domain: {subdomain}.status.phare.io
timeframeNoNumber of days of status and incident history to display.
access_ipsNoList of IP addresses or CIDR ranges allowed to access the status page. Requires an active Scale plan subscription.
componentsNoList of components to show on the status page. A monitor can only be shown once on a status page.
created_atNoDate of creation for the entity
is_privateNoWhether access to the status page is restricted by a password, a secret token or an IP allowlist
project_idNoParent project ID
updated_atNoDate of last update for the entity
descriptionNoStatus page HTML description
website_urlNoURL to redirect users clicking the status page logo
color_schemeNoChoose the available color schemes for the status pageall
show_response_timesNoWhether to display response times for monitors on the status page
access_token_enabledNoWhether the status page is protected by a secret token. Requires an active Scale plan subscription.
search_engine_indexedNoWhether search engines are allowed to index the page
subscription_channelsNoList of active subscription channels
access_password_enabledNoWhether the status page is protected by a password. Requires an active Scale plan subscription.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "access_ips": {
+      "description": "List of IP addresses or CIDR ranges allowed to access the status page. Requires an active Scale plan subscription.",
+      "items": {
+        "examples": [
+          "45.129.56.0/24"
+        ],
+        "type": "string"
+      },
+      "type": [
+        "array",
+        "null"
+      ]
+    },
+    "access_password_enabled": {
+      "description": "Whether the status page is protected by a password. Requires an active Scale plan subscription.",
+      "examples": [
+        false
+      ],
+      "type": "boolean"
+    },
+    "access_token_enabled": {
+      "description": "Whether the status page is protected by a secret token. Requires an active Scale plan subscription.",
+      "examples": [
+        false
+      ],
+      "type": "boolean"
+    },
+    "color_scheme": {
+      "default": "all",
+      "description": "Choose the available color schemes for the status page",
+      "enum": [
+        "all",
+        "dark",
+        "light"
+      ],
+      "examples": [
+        "all"
+      ],
+      "type": "string"
+    },
+    "components": {
+      "description": "List of components to show on the status page. A monitor can only be shown once on a status page.",
+      "items": {
+        "anyOf": [
+          {
+            "properties": {
+              "componentable_id": {
+                "description": "ID of the monitor to show",
+                "type": "integer"
+              },
+              "componentable_type": {
+                "description": "Shows a monitor",
+                "enum": [
+                  "uptime/monitor"
+                ],
+                "type": "string"
+              }
+            },
+            "title": "Monitor component",
+            "type": "object"
+          },
+          {
+            "properties": {
+              "componentable_type": {
+                "description": "Shows a group of monitors",
+                "enum": [
+                  "uptime/group"
+                ],
+                "type": "string"
+              },
+              "components": {
+                "description": "List of monitor components shown inside the group",
+                "items": {
+                  "properties": {
+                    "componentable_id": {
+                      "description": "ID of the monitor to show",
+                      "type": "integer"
+                    },
+                    "componentable_type": {
+                      "description": "Shows a monitor",
+                      "enum": [
+                        "uptime/monitor"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "is_expanded": {
+                "default": false,
+                "description": "Whether the group components are expanded by default",
+                "examples": [
+                  false
+                ],
+                "type": "boolean"
+              },
+              "name": {
+                "description": "Name of the group shown on the status page. Must be unique within the status page (case-insensitive).",
+                "type": "string"
+              }
+            },
+            "title": "Group component",
+            "type": "object"
+          }
+        ]
+      },
+      "type": "array"
+    },
+    "created_at": {
+      "description": "Date of creation for the entity",
+      "format": "date-time",
+      "type": "string"
+    },
+    "description": {
+      "description": "Status page HTML description",
+      "examples": [
+        "Status page of phare.io"
+      ],
+      "type": "string"
+    },
+    "domain": {
+      "description": "Custom domain name for the status page",
+      "examples": [
+        "status.example.com"
+      ],
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "id": {
+      "description": "Status page ID",
+      "examples": [
+        1
+      ],
+      "type": "integer"
+    },
+    "is_private": {
+      "description": "Whether access to the status page is restricted by a password, a secret token or an IP allowlist",
+      "examples": [
+        false
+      ],
+      "type": "boolean"
+    },
+    "name": {
+      "description": "Status page name",
+      "examples": [
+        "Phare status"
+      ],
+      "type": "string"
+    },
+    "project_id": {
+      "description": "Parent project ID",
+      "examples": [
+        1
+      ],
+      "type": "integer"
+    },
+    "search_engine_indexed": {
+      "description": "Whether search engines are allowed to index the page",
+      "examples": [
+        true
+      ],
+      "type": "boolean"
+    },
+    "show_response_times": {
+      "default": true,
+      "description": "Whether to display response times for monitors on the status page",
+      "examples": [
+        true
+      ],
+      "type": "boolean"
+    },
+    "subdomain": {
+      "description": "Subdomain name for the status page, hosted on a phare.io domain: {subdomain}.status.phare.io",
+      "examples": [
+        "example"
+      ],
+      "type": "string"
+    },
+    "subscription_channels": {
+      "description": "List of active subscription channels",
+      "items": {
+        "enum": [
+          "rss",
+          "atom",
+          "slack"
+        ],
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "tags": {
+      "description": "Resource tags, made of lowercase letters, numbers, `.`, `_`, `:` and `-`. An organization can have up to 200 tags.",
+      "items": {
+        "examples": [
+          "environment:production"
+        ],
+        "type": "string"
+      },
+      "type": [
+        "array",
+        "null"
+      ]
+    },
+    "theme": {
+      "description": "Theme settings to customize the status page",
+      "properties": {
+        "border_width": {
+          "default": 1,
+          "description": "Width of the borders, in pixels, from 2 the icons are drawn bolder too",
+          "examples": [
+            2
+          ],
+          "type": "integer"
+        },
+        "dark": {
+          "description": "Dark theme colors, as lowercase 6-digit hexadecimal codes",
+          "properties": {
+            "background": {
+              "description": "Page background color",
+              "examples": [
+                "#111111"
+              ],
+              "type": "string"
+            },
+            "background_card": {
+              "description": "Background color of the cards",
+              "examples": [
+                "#1a1a1a"
+              ],
+              "type": "string"
+            },
+            "border": {
+              "description": "Border color",
+              "examples": [
+                "#3f3f46"
+              ],
+              "type": "string"
+            },
+            "degraded_performance": {
+              "description": "Color of the degraded performance status, and of the timeline days with a degraded performance incident",
+              "examples": [
+                "#fbbf24"
+              ],
+              "type": "string"
+            },
+            "empty": {
+              "description": "Color of the timeline days without data, before the monitor was created",
+              "examples": [
+                "#d3d3d3"
+              ],
+              "type": "string"
+            },
+            "foreground": {
+              "description": "Text color",
+              "examples": [
+                "#ffffff"
+              ],
+              "type": "string"
+            },
+            "foreground_muted": {
+              "description": "Secondary text color",
+              "examples": [
+                "#959595"
+              ],
+              "type": "string"
+            },
+            "maintenance": {
+              "description": "Color of the maintenance status, and of the timeline days with a maintenance",
+              "examples": [
+                "#6366f1"
+              ],
+              "type": "string"
+            },
+            "major_outage": {
+              "description": "Color of the major outage status, and of the timeline days with a major outage incident",
+              "examples": [
+                "#ef4444"
+              ],
+              "type": "string"
+            },
+            "operational": {
+              "description": "Color of the operational status, and of the timeline days without incident",
+              "examples": [
+                "#16a34a"
+              ],
+              "type": "string"
+            },
+            "partial_outage": {
+              "description": "Color of the partial outage status, and of the timeline days with a partial outage incident",
+              "examples": [
+                "#f59e0b"
+              ],
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "light": {
+          "description": "Light theme colors, as lowercase 6-digit hexadecimal codes",
+          "properties": {
+            "background": {
+              "description": "Page background color",
+              "examples": [
+                "#ffffff"
+              ],
+              "type": "string"
+            },
+            "background_card": {
+              "description": "Background color of the cards",
+              "examples": [
+                "#fafafa"
+              ],
+              "type": "string"
+            },
+            "border": {
+              "description": "Border color",
+              "examples": [
+                "#e5e5e5"
+              ],
+              "type": "string"
+            },
+            "degraded_performance": {
+              "description": "Color of the degraded performance status, and of the timeline days with a degraded performance incident",
+              "examples": [
+                "#fbbf24"
+              ],
+              "type": "string"
+            },
+            "empty": {
+              "description": "Color of the timeline days without data, before the monitor was created",
+              "examples": [
+                "#d3d3d3"
+              ],
+              "type": "string"
+            },
+            "foreground": {
+              "description": "Text color",
+              "examples": [
+                "#000000"
+              ],
+              "type": "string"
+            },
+            "foreground_muted": {
+              "description": "Secondary text color",
+              "examples": [
+                "#737373"
+              ],
+              "type": "string"
+            },
+            "maintenance": {
+              "description": "Color of the maintenance status, and of the timeline days with a maintenance",
+              "examples": [
+                "#6366f1"
+              ],
+              "type": "string"
+            },
+            "major_outage": {
+              "description": "Color of the major outage status, and of the timeline days with a major outage incident",
+              "examples": [
+                "#ef4444"
+              ],
+              "type": "string"
+            },
+            "operational": {
+              "description": "Color of the operational status, and of the timeline days without incident",
+              "examples": [
+                "#16a34a"
+              ],
+              "type": "string"
+            },
+            "partial_outage": {
+              "description": "Color of the partial outage status, and of the timeline days with a partial outage incident",
+              "examples": [
+                "#f59e0b"
+              ],
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "rounded": {
+          "default": true,
+          "description": "Whether the corners of the page elements are rounded, square otherwise",
+          "examples": [
+            true
+          ],
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "timeframe": {
+      "description": "Number of days of status and incident history to display.",
+      "enum": [
+        30,
+        60,
+        90
+      ],
+      "examples": [
+        90
+      ],
+      "type": "integer"
+    },
+    "timezone": {
+      "default": "UTC",
+      "description": "Timezone used to split the status page timeline into days and to display all dates on the status page and in feeds. Must be a canonical IANA timezone identifier (case-sensitive, e.g. `Europe/Paris`, `America/New_York` or `UTC`).",
+      "examples": [
+        "Europe/Paris"
+      ],
+      "type": "string"
+    },
+    "title": {
+      "description": "Status page HTML title",
+      "examples": [
+        "Phare status"
+      ],
+      "type": "string"
+    },
+    "updated_at": {
+      "description": "Date of last update for the entity",
+      "format": "date-time",
+      "type": "string"
+    },
+    "website_url": {
+      "description": "URL to redirect users clicking the status page logo",
+      "examples": [
+        "https://phare.io"
+      ],
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is fully covered. The description adds only that components are included in the result and that status is reported by a separate path; it says nothing about error behavior for a missing ID or about the size/shape of the component list.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first sentence is efficient and front-loaded, but the second sentence ('The status it shows is returned by its current status') is circular and ambiguous, forcing the reader to decode what it means rather than delivering new information clearly.

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 covering return values, rich read-only annotations, and full schema parameter coverage, the description only needs to establish scope and the components-inclusion behavior, which it does. Minor gaps remain around failure modes and the exact relationship to the current-status sibling, but nothing essential for a correct call 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 description coverage is 100%, so both project_id and status_page_id are already documented, with project_id even pointing to whoami. The description adds no syntax, format, or cross-parameter nuance beyond 'by ID', 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?

The description names a specific verb and resource ('Get the settings of a status page by ID') and clarifies that components are bundled into the response. It gestures at the sibling get_status_page_current_status via the note about status, but the phrasing is indirect rather than a clean differentiation.

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: an agent can infer this is the retrieval-by-ID call and that status data comes from elsewhere. There is no explicit 'use this when / use X instead' guidance, and the reference to 'its current status' never names the sibling tool that actually returns it.

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

All Phare toolsInspect
Try in Browser
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources