+
+ {step.description} +
+{commands}
+ ) : (
+ <>
+ {commands.map((command, i) => (
+ {command}
+ {i < commands.length - 1 && (
+ or
+ )}
+ + {command.description} +
+{command.command}
+ npx skills add openstatushq/cli
+ + {action.description} +
+{action.template}
+ @openstatusHQ/cli-template
+ {" "}
+ repository for more.
+ + {template.description} +
+{template.template}
+ /mcp, select{" "}
+ openstatus and choose Authenticate.
+ Your browser opens the consent screen.
+
+ ),
+ snippets: [
+ {
+ description: "OAuth (recommended)",
+ code: `claude mcp add --transport http --scope user openstatus ${ENDPOINT}`,
+ },
+ {
+ description: "API key (headless)",
+ code: `claude mcp add --transport http --scope user openstatus ${ENDPOINT} --header "x-openstatus-key: os_..."`,
+ },
+ ],
+ },
+ {
+ value: "claude",
+ label: "Claude.ai / Desktop",
+ description: (
+ <>
+ Open Settings, Connectors,{" "}
+ Add custom connector, paste the URL and click{" "}
+ Connect. Approve on the consent screen and enable the
+ connector in the chat's tool picker.
+
+ ),
+ snippets: [
+ { description: "Server URL", code: ENDPOINT },
+ {
+ description: "API key via mcp-remote (Claude Desktop only)",
+ code: `{
+ "mcpServers": {
+ "openstatus": {
+ "command": "npx",
+ "args": [
+ "mcp-remote",
+ "${ENDPOINT}",
+ "--header",
+ "x-openstatus-key: \${API_KEY}"
+ ],
+ "env": {
+ "API_KEY": "os_..."
+ }
+ }
+ }
+}`,
+ },
+ ],
+ },
+ {
+ value: "cursor",
+ label: "Cursor",
+ description: (
+ <>
+ Add the server to .cursor/mcp.json (project) or{" "}
+ ~/.cursor/mcp.json (global). Cursor shows it as{" "}
+ Needs login; click it to run the OAuth flow.
+
+ ),
+ snippets: [
+ {
+ description: "OAuth (recommended)",
+ code: `{
+ "mcpServers": {
+ "openstatus": {
+ "url": "${ENDPOINT}"
+ }
+ }
+}`,
+ },
+ {
+ description: "API key",
+ code: `{
+ "mcpServers": {
+ "openstatus": {
+ "url": "${ENDPOINT}",
+ "headers": { "x-openstatus-key": "os_..." }
+ }
+ }
+}`,
+ },
+ ],
+ },
+ {
+ value: "opencode",
+ label: "opencode",
+ description: (
+ <>
+ Add the server to opencode.json, then run{" "}
+ opencode mcp auth openstatus to complete the OAuth flow.
+
+ ),
+ snippets: [
+ {
+ description: "OAuth (recommended)",
+ code: `{
+ "$schema": "https://opencode.ai/config.json",
+ "mcp": {
+ "openstatus": {
+ "type": "remote",
+ "url": "${ENDPOINT}",
+ "enabled": true
+ }
+ }
+}`,
+ },
+ {
+ description: "API key",
+ code: `{
+ "$schema": "https://opencode.ai/config.json",
+ "mcp": {
+ "openstatus": {
+ "type": "remote",
+ "url": "${ENDPOINT}",
+ "enabled": true,
+ "headers": { "x-openstatus-key": "{env:OPENSTATUS_API_KEY}" },
+ "oauth": false
+ }
+ }
+}`,
+ },
+ ],
+ },
+ {
+ value: "chatgpt",
+ label: "ChatGPT",
+ description: (
+ <>
+ Open Settings, Connectors,{" "}
+ Create, enter the URL as the MCP server URL with{" "}
+ OAuth authentication, and complete the consent screen.
+
+ ),
+ snippets: [{ description: "Server URL", code: ENDPOINT }],
+ },
+];
+
+const prompts = [
+ {
+ description: "Check the health of a monitor before a release.",
+ prompt: "How did the checkout API perform over the last 7 days?",
+ },
+ {
+ description: "Draft an incident. The assistant asks before notifying.",
+ prompt:
+ "Create a status report on the API status page: elevated error rates on payments, status investigating.",
+ },
+ {
+ description: "Update subscribers on an ongoing incident.",
+ prompt:
+ "Post an update that we identified the cause and a fix is rolling out.",
+ },
+ {
+ description: "Plan downtime ahead of time.",
+ prompt:
+ "Schedule a maintenance window for the database next Friday from 2 to 3 PM UTC.",
+ },
+];
+
+const tools = [
+ {
+ group: "Status pages",
+ items: ["list_status_pages", "list_page_components"],
+ },
+ {
+ group: "Status reports",
+ items: [
+ "list_status_reports",
+ "create_status_report",
+ "add_status_report_update",
+ "update_status_report",
+ "resolve_status_report",
+ ],
+ },
+ {
+ group: "Maintenance",
+ items: ["list_maintenances", "create_maintenance"],
+ },
+ {
+ group: "Monitors",
+ items: [
+ "list_monitors",
+ "get_monitor",
+ "get_monitor_status",
+ "get_monitor_summary",
+ "list_response_logs",
+ "get_response_log",
+ ],
+ },
+ {
+ group: "Workspace",
+ items: [
+ "list_notifications",
+ "list_private_locations",
+ "list_audit_logs",
+ "get_audit_log",
+ ],
+ },
+];
+
+export default function Page() {
+ return (
+ {ENDPOINT}
+ + {client.description} +
+ {client.snippets.map((snippet) => ( ++ {snippet.description} +
+{snippet.code}
+
+ For CI, cron jobs or agents running on a server, send an API key in
+ the x-openstatus-key header instead. Create one in the{" "}
+ general settings. The key's
+ read-only or read & write scope decides which tools the server
+ exposes.
+
+ {item.description} +
+{item.prompt}
+ {tool.group}
+{tool.items.join("\n")}
+ - {message.description} -
-{message.message}
- - {command.description} -
-{command.command}
- + {message.description} +
+{message.message}
+ + {command.description} +
+{command.command}
+
-
- {step.description} -
-{commands}
- ) : (
- <>
- {commands.map((command, i) => (
- {command}
- {i < commands.length - 1 && (
- or
- )}
- - {command.description} -
-{command.command}
- npx skills add openstatushq/cli
- - {action.description} -
-{action.template}
- @openstatusHQ/cli-template
- {" "}
- repository for more.
- - {template.description} -
-{template.template}
-