Skip to content

Open-source status page, incident response and uptime monitoring

✍️ guide MCP server (#1278)

Thibault Le Ouay3f765e00cca6
diff --git a/.github/workflows/dx.yml b/.github/workflows/dx.yml
index 2cb0fa080..f34f90e37 100644
--- a/.github/workflows/dx.yml
+++ b/.github/workflows/dx.yml
@@ -32,7 +32,7 @@ jobs:
- name: Set up pnpm
uses: pnpm/action-setup@v4
with:
- version: 10.11.0
+ version: 10.12.4
- name: ⎔ Setup node
uses: actions/setup-node@v4
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 46948e1bc..8ec72d746 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -22,7 +22,7 @@ jobs:
- name: Set up pnpm
uses: pnpm/action-setup@v4
with:
- version: 10.11.0
+ version: 10.12.4
- name: ⎔ Setup node
uses: actions/setup-node@v4
diff --git a/.github/workflows/migrate.yml b/.github/workflows/migrate.yml
index fbe844111..20c59483b 100644
--- a/.github/workflows/migrate.yml
+++ b/.github/workflows/migrate.yml
@@ -19,7 +19,7 @@ jobs:
- name: Set up pnpm
uses: pnpm/action-setup@v4
with:
- version: 10.11.0
+ version: 10.12.4
- name: ⎔ Setup node
uses: actions/setup-node@v4
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 49bd5210f..b0fcd4332 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -32,7 +32,7 @@ jobs:
- name: Set up pnpm
uses: pnpm/action-setup@v4
with:
- version: 10.11.0
+ version: 10.12.4
- name: ⎔ Setup node
uses: actions/setup-node@v4
diff --git a/apps/docs/.env.example b/apps/docs/.env.example
index d5de49bef..e958a6227 100644
--- a/apps/docs/.env.example
+++ b/apps/docs/.env.example
@@ -1 +1 @@
-NEXT_PUBLIC_OPENPANEL_CLIENT_ID=
\ No newline at end of file
+NEXT_PUBLIC_OPENPANEL_CLIENT_ID=your-id
diff --git a/apps/docs/src/content/docs/guides/how-to-monitor-mcp-server.mdx b/apps/docs/src/content/docs/guides/how-to-monitor-mcp-server.mdx
new file mode 100644
index 000000000..3e9d8abaa
--- /dev/null
+++ b/apps/docs/src/content/docs/guides/how-to-monitor-mcp-server.mdx
@@ -0,0 +1,119 @@
+---
+title: How to monitor your Model Context Provider (MCP) server?
+description: Learn how to monitor your MCP server with openstatus.
+sidebar:
+ label: Monitor your MCP Server
+---
+In this guide, we will show you how to monitor your remote MCP server using OpenStatus. We will use the Hugging Face MCP server for this article, but you can apply the same principles to any MCP server. You can find the code for this guide on [GitHub](https://github.com/openstatusHQ/template/tree/a69eac06e9d3d8579768dad803304e456f56ec33/mcp-server).
+
+**Prerequisites**
+
+- An OpenStatus account and CLI
+- An MCP server
+
+## Model Context Provider (MCP)
+
+A Model Context Provider is a component that supplies additional context, data, or capabilities to AI models during runtime through the Model Context Protocol (MCP). It acts as a bridge, allowing AI models to access external resources such as databases, APIs, file systems, or other services not included in their original training data.
+
+### What is an MCP Server?
+
+The server component of the MCP protocol hosts and manages external resources, tools, or data sources that AI models can access. It handles incoming requests from MCP clients, processes them according to the protocol specifications, and returns the requested information or executes the specified actions. The MCP server serves as the backend provider, exposing capabilities like database queries, file operations, or API calls in a standardized format for AI models to interact with.
+
+The protocol must adhere to the [JSON-RPC 2.0 specification](https://www.jsonrpc.org/specification).
+
+### JSON-RPC Protocol
+
+JSON-RPC is a remote procedure call protocol that uses JSON as its data format. It is designed to be simple and easy to implement while providing a robust and flexible way to communicate between clients and servers. The JSON-RPC protocol is transport-independent, but for MCP servers, it uses HTTP/HTTPS, making it easy to monitor with OpenStatus.
+
+### Ping Utility
+
+The official [MCP documentation](https://modelcontextprotocol.io/docs/concepts/architecture#debugging-and-monitoring) recommends implementing a health check for your MCP server. The protocol includes a mechanism to verify that the server is still responsive: the ping utility. The ping feature operates using a basic request/response mechanism.
+
+## Create Your OpenStatus Monitor
+
+ OpenStatus allows you to monitor your MCP server by sending a ping request to your MCP server's endpoint on a regular basis from multiple locations around the world. Making it easy to monitor your remote MCP server's health and performance.
+
+### YAML Configuration
+
+The [OpenStatus CLI](/cli/getting-started/) allows you to create monitor defined in a YAML configuration file. This is perfect solution if want to manage your monitors via GitOps.
+
+Here's an example of a monitor configuration for Hugging Face MCP server:
+
+```YAML
+# yaml-language-server: $schema=https://www.openstatus.dev/schema.json
+
+mcp-server:
+ name: "HF MCP Server"
+ description: "Hugging Face MCP server monitoring"
+ frequency: "1m"
+ active: true
+ regions: ["iad", "ams", "lax"]
+ retry: 3
+ kind: http
+ request:
+ url: https://hf.co/mcp
+ method: POST
+ body: >
+ {
+ "jsonrpc": "2.0",
+ "id": "openstatus",
+ "method": "ping"
+ }
+ headers:
+ User-Agent: OpenStatus
+ Accept: application/json, text/event-stream
+ Content-Type: application/json
+ assertions:
+ - kind: statusCode
+ compare: eq
+ target: 200
+ - kind: textBody
+ compare: eq
+ target: '{"result":{},"jsonrpc":"2.0","id":"openstatus"}'
+```
+
+### What Does This Monitor Do?
+
+We send an HTTP POST request to the MCP server. The request body contains a JSON-RPC request with the method "ping".
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": "openstatus",
+ "method": "ping"
+}
+```
+
+We set our headers to accept `application/json` and `text/event-stream`. We also include assertions to verify the response.
+
+First, we check that the status code is 200.
+
+```YAML
+ - kind: statusCode
+ compare: eq
+ target: 200
+```
+
+Next, we verify that the response body is correct.
+
+```YAML
+ - kind: textBody
+ compare: eq
+ target: '{"result":{},"jsonrpc":"2.0","id":"openstatus"}'
+```
+
+### Using OpenStatus CLI to Create Your Monitor
+
+To create your monitor, use the OpenStatus CLI.
+
+```bash
+openstatus create openstatus.yaml
+```
+
+## Conclusion
+
+This guide has shown you how to create a monitor for your MCP server using the OpenStatus CLI. You can view the monitor in the OpenStatus dashboard.
+
+For example, here is our monitor for the HF MCP server:
+
+[https://www.openstatus.dev/public/monitors/5961](https://www.openstatus.dev/public/monitors/5961)
diff --git a/apps/docs/src/content/docs/guides/how-to-run-synthetic-test-github-action.mdx b/apps/docs/src/content/docs/guides/how-to-run-synthetic-test-github-action.mdx
index f25af6282..80971bb19 100644
--- a/apps/docs/src/content/docs/guides/how-to-run-synthetic-test-github-action.mdx
+++ b/apps/docs/src/content/docs/guides/how-to-run-synthetic-test-github-action.mdx
@@ -2,7 +2,7 @@
title: How to run a synthetic test in a GitHub Action
description: Learn how to run a synthetic test in a GitHub Action using OpenStatus.
sidebar:
- label: GitHub Action for Synthetics
+ label: GitHub Action for Synthetics Tests
---
In this guide, we will show you how to run a synthetic test in a GitHub Action using OpenStatus.
@@ -65,4 +65,4 @@ jobs:
### Run the GitHub Action
-On every push to the main branch, the GitHub Action will run the synthetic tests you have configured in the configuration file.
\ No newline at end of file
+On every push to the main branch, the GitHub Action will run the synthetic tests you have configured in the configuration file.
diff --git a/apps/docs/src/content/docs/guides/introduction.mdx b/apps/docs/src/content/docs/guides/introduction.mdx
index d144d2fb0..f1b0e341c 100644
--- a/apps/docs/src/content/docs/guides/introduction.mdx
+++ b/apps/docs/src/content/docs/guides/introduction.mdx
@@ -12,4 +12,6 @@ Here's some content for the getting started with OpenStatus.
- [Deploy your own Status Page to Cloudflare Pages](/guides/how-deploy-status-page-cf-pages)
-- [How to run synthetic tests in your GitHub Actions](/guides/how-to-run-synthetic-test-github-action/)
\ No newline at end of file
+- [How to monitor your MCP Server using OpenStatus](/guides/how-to-monitor-mcp-server/)
+
+- [How to run synthetic tests in your GitHub Actions](/guides/how-to-run-synthetic-test-github-action/)
diff --git a/package.json b/package.json
index d00a8b708..ea167ad7d 100644
--- a/package.json
+++ b/package.json
@@ -21,7 +21,7 @@
"turbo": "2.3.2",
"typescript": "5.7.2"
},
- "packageManager": "[email protected]",
+ "packageManager": "[email protected]",
"pnpm": {
"onlyBuiltDependencies": ["@swc/core", "sharp"]
},