mirror of
https://github.com/OneUptime/oneuptime.git
synced 2026-04-06 00:32:12 +02:00
feat: Add MCP Server documentation and navigation links
This commit is contained in:
Simon Larsen
168
Docs/Content/mcp/configuration.md
Normal file
168
Docs/Content/mcp/configuration.md
Normal file
@@ -0,0 +1,168 @@
|
||||
# Configuration
|
||||
|
||||
Learn how to configure the OneUptime MCP Server for your specific needs.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
The MCP server uses environment variables for configuration:
|
||||
|
||||
| Variable | Description | Required | Default | Example |
|
||||
|----------|-------------|----------|---------|---------|
|
||||
| `ONEUPTIME_API_KEY` | Your OneUptime API key | **Yes** | - | `xxxxxxxx-xxxx-xxxx-xxxx` |
|
||||
| `ONEUPTIME_URL` | Your OneUptime instance URL | No | `https://oneuptime.com` | `https://my-company.oneuptime.com` |
|
||||
|
||||
## Setting Environment Variables
|
||||
|
||||
### In Claude Desktop Configuration
|
||||
|
||||
The recommended way is to set environment variables in your Claude Desktop configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"oneuptime": {
|
||||
"command": "oneuptime-mcp",
|
||||
"env": {
|
||||
"ONEUPTIME_API_KEY": "your-api-key-here",
|
||||
"ONEUPTIME_URL": "https://your-instance.oneuptime.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### System Environment Variables
|
||||
|
||||
Alternatively, you can set system environment variables:
|
||||
|
||||
**macOS/Linux**:
|
||||
```bash
|
||||
export ONEUPTIME_API_KEY="your-api-key-here"
|
||||
export ONEUPTIME_URL="https://your-instance.oneuptime.com"
|
||||
```
|
||||
|
||||
**Windows**:
|
||||
```cmd
|
||||
set ONEUPTIME_API_KEY=your-api-key-here
|
||||
set ONEUPTIME_URL=https://your-instance.oneuptime.com
|
||||
```
|
||||
|
||||
### Using .env File
|
||||
|
||||
For development, you can create a `.env` file in your working directory:
|
||||
|
||||
```env
|
||||
ONEUPTIME_API_KEY=your-api-key-here
|
||||
ONEUPTIME_URL=https://your-instance.oneuptime.com
|
||||
```
|
||||
|
||||
## API Key Permissions
|
||||
|
||||
Your API key needs appropriate permissions based on what operations you want to perform:
|
||||
|
||||
### Read-Only Access
|
||||
For viewing data only:
|
||||
- `Project:Read`
|
||||
- `Monitor:Read`
|
||||
- `Incident:Read`
|
||||
- `Team:Read`
|
||||
- `StatusPage:Read`
|
||||
|
||||
### Full Access
|
||||
For complete management capabilities:
|
||||
- `Project:Read,Create,Update,Delete`
|
||||
- `Monitor:Read,Create,Update,Delete`
|
||||
- `Incident:Read,Create,Update,Delete`
|
||||
- `Team:Read,Create,Update,Delete`
|
||||
- `StatusPage:Read,Create,Update,Delete`
|
||||
- And other permissions as needed
|
||||
|
||||
### Minimal Permissions Example
|
||||
For basic monitoring and incident response:
|
||||
- `Project:Read`
|
||||
- `Monitor:Read,Create,Update`
|
||||
- `Incident:Read,Create,Update`
|
||||
- `Team:Read`
|
||||
|
||||
## Advanced Configuration
|
||||
|
||||
### Multiple Instances
|
||||
|
||||
You can configure multiple OneUptime instances by creating separate MCP server configurations:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"oneuptime-prod": {
|
||||
"command": "oneuptime-mcp",
|
||||
"env": {
|
||||
"ONEUPTIME_API_KEY": "prod-api-key",
|
||||
"ONEUPTIME_URL": "https://prod.oneuptime.com"
|
||||
}
|
||||
},
|
||||
"oneuptime-staging": {
|
||||
"command": "oneuptime-mcp",
|
||||
"env": {
|
||||
"ONEUPTIME_API_KEY": "staging-api-key",
|
||||
"ONEUPTIME_URL": "https://staging.oneuptime.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Custom Command Path
|
||||
|
||||
If you installed from source or want to use a specific version:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"oneuptime": {
|
||||
"command": "/path/to/your/oneuptime-mcp",
|
||||
"env": {
|
||||
"ONEUPTIME_API_KEY": "your-api-key-here"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Configuration Validation
|
||||
|
||||
To verify your configuration is working:
|
||||
|
||||
1. **Check API Key**: Ensure your API key is valid and has proper permissions
|
||||
2. **Test Connection**: Ask Claude to list your projects or monitors
|
||||
3. **Verify Permissions**: Try creating a simple resource to test write access
|
||||
|
||||
## Troubleshooting Configuration
|
||||
|
||||
### Invalid API Key
|
||||
- Verify the API key in your OneUptime settings
|
||||
- Check for extra spaces or characters
|
||||
- Ensure the key hasn't expired
|
||||
|
||||
### Wrong URL
|
||||
- Verify your OneUptime instance URL
|
||||
- Ensure it includes the protocol (https://)
|
||||
- Check for typos in the domain
|
||||
|
||||
### Permission Denied
|
||||
- Review your API key permissions
|
||||
- Contact your OneUptime administrator if needed
|
||||
- Try with a more permissive API key for testing
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
1. **Use Specific Permissions**: Only grant the minimum permissions needed
|
||||
2. **Rotate API Keys**: Regularly rotate your API keys
|
||||
3. **Monitor Usage**: Keep track of API key usage in OneUptime
|
||||
4. **Separate Keys**: Use different API keys for different environments
|
||||
5. **Store Securely**: Never commit API keys to version control
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Explore usage examples](/docs/mcp/examples)
|
||||
- [View available resources](/docs/mcp/resources)
|
||||
- [Learn about troubleshooting](/docs/mcp/troubleshooting)
|
||||
259
Docs/Content/mcp/examples.md
Normal file
259
Docs/Content/mcp/examples.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# Usage Examples
|
||||
|
||||
Learn how to use the OneUptime MCP Server with practical examples and common use cases.
|
||||
|
||||
## Getting Started Examples
|
||||
|
||||
### Basic Information Queries
|
||||
|
||||
**List all projects:**
|
||||
```
|
||||
"Show me all my OneUptime projects"
|
||||
```
|
||||
|
||||
**Check monitor status:**
|
||||
```
|
||||
"What's the current status of all my monitors?"
|
||||
```
|
||||
|
||||
**View recent incidents:**
|
||||
```
|
||||
"Show me incidents from the last 24 hours"
|
||||
```
|
||||
|
||||
## Monitor Management
|
||||
|
||||
### Creating Monitors
|
||||
|
||||
**Create a website monitor:**
|
||||
```
|
||||
"Create a new website monitor for https://example.com that checks every 5 minutes"
|
||||
```
|
||||
|
||||
**Create an API monitor:**
|
||||
```
|
||||
"Set up an API monitor for https://api.example.com/health with a 30-second timeout"
|
||||
```
|
||||
|
||||
**Create a ping monitor:**
|
||||
```
|
||||
"Create a ping monitor for server 192.168.1.100"
|
||||
```
|
||||
|
||||
### Managing Existing Monitors
|
||||
|
||||
**Update monitor frequency:**
|
||||
```
|
||||
"Change the monitoring interval for my website monitor to every 2 minutes"
|
||||
```
|
||||
|
||||
**Disable a monitor temporarily:**
|
||||
```
|
||||
"Disable the monitor for staging.example.com while we're doing maintenance"
|
||||
```
|
||||
|
||||
**Add custom headers to HTTP monitor:**
|
||||
```
|
||||
"Add an Authorization header to my API monitor with value 'Bearer token123'"
|
||||
```
|
||||
|
||||
## Incident Management
|
||||
|
||||
### Creating Incidents
|
||||
|
||||
**Create a new incident:**
|
||||
```
|
||||
"Create a high-priority incident for the database outage affecting user authentication"
|
||||
```
|
||||
|
||||
**Create incident with details:**
|
||||
```
|
||||
"Create an incident titled 'Payment Gateway Down' with description 'Users cannot process payments' and assign it to the backend team"
|
||||
```
|
||||
|
||||
### Managing Incidents
|
||||
|
||||
**Add notes to incident:**
|
||||
```
|
||||
"Add a note to incident #123 saying 'Database connection restored, monitoring for stability'"
|
||||
```
|
||||
|
||||
**Update incident status:**
|
||||
```
|
||||
"Mark incident #456 as resolved"
|
||||
```
|
||||
|
||||
**Assign incident to team:**
|
||||
```
|
||||
"Assign the current payment gateway incident to the infrastructure team"
|
||||
```
|
||||
|
||||
## Team and User Management
|
||||
|
||||
### Team Operations
|
||||
|
||||
**List team members:**
|
||||
```
|
||||
"Who are the members of the infrastructure team?"
|
||||
```
|
||||
|
||||
**Add user to team:**
|
||||
```
|
||||
"Add john@example.com to the backend development team"
|
||||
```
|
||||
|
||||
**Check team permissions:**
|
||||
```
|
||||
"What permissions does the frontend team have?"
|
||||
```
|
||||
|
||||
### On-Call Management
|
||||
|
||||
**Check who's on call:**
|
||||
```
|
||||
"Who's currently on call for the infrastructure team?"
|
||||
```
|
||||
|
||||
**View on-call schedule:**
|
||||
```
|
||||
"Show me the on-call schedule for this week"
|
||||
```
|
||||
|
||||
## Status Page Management
|
||||
|
||||
### Status Page Updates
|
||||
|
||||
**Update status page:**
|
||||
```
|
||||
"Update our status page to show 'Investigating Payment Issues' for the payment service"
|
||||
```
|
||||
|
||||
**Create announcement:**
|
||||
```
|
||||
"Create a status page announcement about scheduled maintenance this weekend"
|
||||
```
|
||||
|
||||
**Check current status:**
|
||||
```
|
||||
"What's the current status showing on our public status page?"
|
||||
```
|
||||
|
||||
## Probe Management
|
||||
|
||||
### Managing Probes
|
||||
|
||||
**List all probes:**
|
||||
```
|
||||
"Show me all monitoring probes and their locations"
|
||||
```
|
||||
|
||||
**Create a new probe:**
|
||||
```
|
||||
"Set up a new monitoring probe in the EU-West region"
|
||||
```
|
||||
|
||||
**Check probe health:**
|
||||
```
|
||||
"Are all our monitoring probes healthy and reporting data?"
|
||||
```
|
||||
|
||||
## Analytics and Reporting
|
||||
|
||||
### Performance Queries
|
||||
|
||||
**Monitor uptime stats:**
|
||||
```
|
||||
"What's the uptime percentage for all monitors this month?"
|
||||
```
|
||||
|
||||
**Incident trends:**
|
||||
```
|
||||
"How many incidents did we have last week compared to this week?"
|
||||
```
|
||||
|
||||
**Response time analysis:**
|
||||
```
|
||||
"What are the average response times for our API endpoints today?"
|
||||
```
|
||||
|
||||
## Advanced Use Cases
|
||||
|
||||
### Automated Incident Response
|
||||
|
||||
**Create incident and assign team:**
|
||||
```
|
||||
"Create a critical incident for API timeout issues, assign to DevOps team, and add initial troubleshooting steps to the description"
|
||||
```
|
||||
|
||||
**Bulk monitor updates:**
|
||||
```
|
||||
"Update all website monitors to use a 60-second timeout instead of 30 seconds"
|
||||
```
|
||||
|
||||
### Maintenance Operations
|
||||
|
||||
**Prepare for maintenance:**
|
||||
```
|
||||
"Create a scheduled maintenance window for this Saturday 2-4 AM, disable all monitors for api.example.com during that time, and update the status page"
|
||||
```
|
||||
|
||||
**Post-maintenance cleanup:**
|
||||
```
|
||||
"Re-enable all monitors that were disabled for maintenance and update status page to show all systems operational"
|
||||
```
|
||||
|
||||
### Integration Workflows
|
||||
|
||||
**Monitor creation from incidents:**
|
||||
```
|
||||
"Based on the recent database timeout incident, create a new monitor to check database response time every minute"
|
||||
```
|
||||
|
||||
**Team notification setup:**
|
||||
```
|
||||
"Set up escalation rules so that if any critical monitor fails, it immediately notifies the on-call engineer and escalates to the team lead after 15 minutes"
|
||||
```
|
||||
|
||||
## Complex Queries
|
||||
|
||||
### Multi-step Operations
|
||||
|
||||
```
|
||||
"Show me all monitors that have been down in the last hour, create incidents for any that don't already have one, and assign them to the appropriate teams based on the monitor tags"
|
||||
```
|
||||
|
||||
```
|
||||
"Find all incidents that have been open for more than 24 hours, add a note requesting status updates, and notify the assigned teams"
|
||||
```
|
||||
|
||||
### Conditional Logic
|
||||
|
||||
```
|
||||
"If any monitors in the 'production' group are currently failing, create a high-priority incident and immediately notify the on-call team"
|
||||
```
|
||||
|
||||
```
|
||||
"Check if our main website monitor has been down for more than 5 minutes, and if so, update the status page to show 'investigating connectivity issues'"
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Effective Prompts
|
||||
|
||||
1. **Be Specific**: Include exact names, IDs, or criteria
|
||||
2. **Provide Context**: Mention urgency, affected systems, or business impact
|
||||
3. **Use Natural Language**: The AI understands conversational requests
|
||||
4. **Combine Operations**: Ask for multiple related actions in one request
|
||||
|
||||
### Safety Considerations
|
||||
|
||||
1. **Review Before Executing**: Check what the AI plans to do
|
||||
2. **Start Small**: Test with non-critical resources first
|
||||
3. **Have Rollback Plans**: Know how to reverse changes
|
||||
4. **Monitor Results**: Verify operations completed successfully
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Learn about available resources](/docs/mcp/resources)
|
||||
- [Explore configuration options](/docs/mcp/configuration)
|
||||
- [View troubleshooting guide](/docs/mcp/troubleshooting)
|
||||
59
Docs/Content/mcp/index.md
Normal file
59
Docs/Content/mcp/index.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# OneUptime MCP Server
|
||||
|
||||
The OneUptime Model Context Protocol (MCP) Server provides LLMs with direct access to your OneUptime instance, enabling AI-powered monitoring, incident management, and observability operations.
|
||||
|
||||
## What is the OneUptime MCP Server?
|
||||
|
||||
The OneUptime MCP Server is a bridge between Large Language Models (LLMs) and your OneUptime instance. It implements the Model Context Protocol (MCP), allowing AI assistants like Claude to interact directly with your monitoring infrastructure.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Complete API Coverage**: Access to 711 OneUptime API endpoints
|
||||
- **126 Resource Types**: Manage all OneUptime resources including monitors, incidents, teams, probes, and more
|
||||
- **Real-time Operations**: Create, read, update, and delete resources in real-time
|
||||
- **Type-safe Interface**: Fully typed with comprehensive input validation
|
||||
- **Secure Authentication**: API key-based authentication with proper error handling
|
||||
- **Easy Integration**: Works with Claude Desktop and other MCP-compatible clients
|
||||
|
||||
## What You Can Do
|
||||
|
||||
With the OneUptime MCP Server, AI assistants can help you:
|
||||
|
||||
- **Monitor Management**: Create and configure monitors, check their status, and manage monitor groups
|
||||
- **Incident Response**: Create incidents, add notes, assign team members, and track resolution
|
||||
- **Team Operations**: Manage teams, permissions, and on-call schedules
|
||||
- **Status Pages**: Update status pages, create announcements, and manage subscribers
|
||||
- **Alerting**: Configure alert rules, manage escalation policies, and check notification logs
|
||||
- **Probes**: Deploy and manage monitoring probes across different locations
|
||||
- **Reports & Analytics**: Generate reports and analyze monitoring data
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. [Installation Guide](/docs/mcp/installation) - Install and configure the MCP server
|
||||
2. [Quick Start](/docs/mcp/quick-start) - Get up and running in minutes
|
||||
3. [Configuration](/docs/mcp/configuration) - Detailed configuration options
|
||||
4. [Usage Examples](/docs/mcp/examples) - Common use cases and examples
|
||||
|
||||
## Requirements
|
||||
|
||||
- OneUptime instance (cloud or self-hosted)
|
||||
- Valid OneUptime API key
|
||||
- Node.js 18+ (for development)
|
||||
- MCP-compatible client (Claude Desktop, etc.)
|
||||
|
||||
## Architecture
|
||||
|
||||
The MCP server acts as a translation layer between the Model Context Protocol and OneUptime's REST API:
|
||||
|
||||
```
|
||||
LLM Client (Claude) ↔ MCP Server ↔ OneUptime API
|
||||
```
|
||||
|
||||
This architecture ensures secure, efficient access to your OneUptime data while maintaining proper authentication and authorization.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Install the MCP Server](/docs/mcp/installation)
|
||||
- [Learn about Configuration Options](/docs/mcp/configuration)
|
||||
- [Explore Usage Examples](/docs/mcp/examples)
|
||||
- [View Available Resources](/docs/mcp/resources)
|
||||
79
Docs/Content/mcp/installation.md
Normal file
79
Docs/Content/mcp/installation.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# Installation
|
||||
|
||||
This guide will walk you through installing and setting up the OneUptime MCP Server.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before installing the MCP server, ensure you have:
|
||||
|
||||
- A OneUptime instance (cloud or self-hosted)
|
||||
- A valid OneUptime API key
|
||||
- Node.js 18 or later (for npm installation)
|
||||
|
||||
## Installation Methods
|
||||
|
||||
### Method 1: NPM Installation (Recommended)
|
||||
|
||||
Install the MCP server globally using npm:
|
||||
|
||||
```bash
|
||||
npm install -g @oneuptime/mcp-server
|
||||
```
|
||||
|
||||
This will install the `oneuptime-mcp` command globally on your system.
|
||||
|
||||
### Method 2: From Source
|
||||
|
||||
If you want to build from source or contribute to the project:
|
||||
|
||||
```bash
|
||||
# Clone the OneUptime repository
|
||||
git clone https://github.com/OneUptime/oneuptime.git
|
||||
cd oneuptime
|
||||
|
||||
# Generate the MCP server
|
||||
npm run generate-mcp-server
|
||||
|
||||
# Navigate to the MCP directory
|
||||
cd MCP
|
||||
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Build the project
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Getting Your API Key
|
||||
|
||||
### For OneUptime Cloud
|
||||
|
||||
1. Log in to [OneUptime Cloud](https://oneuptime.com)
|
||||
2. Navigate to **Settings** → **API Keys**
|
||||
3. Click **Create API Key**
|
||||
4. Provide a name (e.g., "MCP Server")
|
||||
5. Select the appropriate permissions for your use case
|
||||
6. Copy the generated API key
|
||||
|
||||
### For Self-Hosted OneUptime
|
||||
|
||||
1. Access your OneUptime instance
|
||||
2. Navigate to **Settings** → **API Keys**
|
||||
3. Click **Create API Key**
|
||||
4. Provide a name (e.g., "MCP Server")
|
||||
5. Select the appropriate permissions
|
||||
6. Copy the generated API key
|
||||
|
||||
## Verification
|
||||
|
||||
Verify your installation by checking the version:
|
||||
|
||||
```bash
|
||||
oneuptime-mcp --version
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Configure the MCP Server](/docs/mcp/configuration)
|
||||
- [Set up with Claude Desktop](/docs/mcp/quick-start)
|
||||
- [Explore configuration options](/docs/mcp/configuration)
|
||||
122
Docs/Content/mcp/quick-start.md
Normal file
122
Docs/Content/mcp/quick-start.md
Normal file
@@ -0,0 +1,122 @@
|
||||
# Quick Start
|
||||
|
||||
Get up and running with the OneUptime MCP Server in just a few minutes.
|
||||
|
||||
## Step 1: Install the MCP Server
|
||||
|
||||
If you haven't already, install the MCP server:
|
||||
|
||||
```bash
|
||||
npm install -g @oneuptime/mcp-server
|
||||
```
|
||||
|
||||
## Step 2: Get Your API Key
|
||||
|
||||
1. Log in to your OneUptime instance
|
||||
2. Go to **Settings** → **API Keys**
|
||||
3. Create a new API key with appropriate permissions
|
||||
4. Copy the API key for use in configuration
|
||||
|
||||
## Step 3: Configure Claude Desktop
|
||||
|
||||
Add the OneUptime MCP server to your Claude Desktop configuration.
|
||||
|
||||
### Find Your Configuration File
|
||||
|
||||
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
||||
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
||||
**Linux**: `~/.config/Claude/claude_desktop_config.json`
|
||||
|
||||
### Update Configuration
|
||||
|
||||
Add the following to your Claude Desktop configuration file:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"oneuptime": {
|
||||
"command": "oneuptime-mcp",
|
||||
"env": {
|
||||
"ONEUPTIME_API_KEY": "your-api-key-here",
|
||||
"ONEUPTIME_URL": "https://oneuptime.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**For self-hosted OneUptime**, replace `https://oneuptime.com` with your instance URL.
|
||||
|
||||
### Example Complete Configuration
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"oneuptime": {
|
||||
"command": "oneuptime-mcp",
|
||||
"env": {
|
||||
"ONEUPTIME_API_KEY": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
||||
"ONEUPTIME_URL": "https://my-company.oneuptime.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Step 4: Restart Claude Desktop
|
||||
|
||||
Close and restart Claude Desktop for the configuration changes to take effect.
|
||||
|
||||
## Step 5: Test the Connection
|
||||
|
||||
Once Claude Desktop restarts, you can test the MCP server by asking Claude to:
|
||||
|
||||
- "List my OneUptime projects"
|
||||
- "Show me recent incidents"
|
||||
- "What monitors are currently down?"
|
||||
- "Create a new monitor for my website"
|
||||
|
||||
## Example Conversation
|
||||
|
||||
Here's what you can do once everything is set up:
|
||||
|
||||
**You**: "Can you show me all my OneUptime projects?"
|
||||
|
||||
**Claude**: "I'll list your OneUptime projects for you."
|
||||
|
||||
*Claude will use the MCP server to fetch and display your projects*
|
||||
|
||||
**You**: "Create a new monitor for https://example.com"
|
||||
|
||||
**Claude**: "I'll create a website monitor for https://example.com."
|
||||
|
||||
*Claude will use the MCP server to create the monitor*
|
||||
|
||||
## Common Issues
|
||||
|
||||
### Permission Errors
|
||||
|
||||
If you see permission errors, ensure your API key has the necessary permissions:
|
||||
- Read access for listing resources
|
||||
- Write access for creating/updating resources
|
||||
- Delete access if you want to remove resources
|
||||
|
||||
### Connection Issues
|
||||
|
||||
If Claude can't connect to your OneUptime instance:
|
||||
1. Verify your `ONEUPTIME_URL` is correct
|
||||
2. Check that your API key is valid
|
||||
3. Ensure your OneUptime instance is accessible
|
||||
|
||||
### MCP Server Not Found
|
||||
|
||||
If you get "command not found" errors:
|
||||
1. Verify the installation: `npm list -g @oneuptime/mcp-server`
|
||||
2. Check your PATH includes npm global binaries
|
||||
3. Try reinstalling: `npm install -g @oneuptime/mcp-server`
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Learn about configuration options](/docs/mcp/configuration)
|
||||
- [Explore usage examples](/docs/mcp/examples)
|
||||
- [View available resources](/docs/mcp/resources)
|
||||
240
Docs/Content/mcp/resources.md
Normal file
240
Docs/Content/mcp/resources.md
Normal file
@@ -0,0 +1,240 @@
|
||||
# Available Resources
|
||||
|
||||
The OneUptime MCP Server provides access to 126 different resource types across your OneUptime instance. Here's a comprehensive overview of what you can manage.
|
||||
|
||||
## Core Resources
|
||||
|
||||
### User Management
|
||||
- **User**: Manage user accounts and profiles
|
||||
- **TeamMember**: Handle team membership relationships
|
||||
- **TeamPermission**: Control access permissions within teams
|
||||
- **TwoFactorAuth**: Manage two-factor authentication settings
|
||||
|
||||
### Project and Team Management
|
||||
- **Project**: Create and manage monitoring projects
|
||||
- **Team**: Organize users into teams with specific roles
|
||||
- **TeamOwner**: Manage team ownership relationships
|
||||
|
||||
### Authentication and Security
|
||||
- **APIKey**: Generate and manage API keys for integrations
|
||||
- **APIKeyPermission**: Control what each API key can access
|
||||
- **Label**: Create labels for organizing resources
|
||||
|
||||
## Monitoring and Observability
|
||||
|
||||
### Monitors
|
||||
- **Monitor**: Configure and manage all types of monitors
|
||||
- **MonitorSecret**: Store sensitive data for monitor configurations
|
||||
- **MonitorStatus**: Track the current state of monitors
|
||||
- **MonitorCustomField**: Add custom metadata to monitors
|
||||
- **MonitorProbe**: Assign probes to monitors
|
||||
- **MonitorTeamOwner**: Manage monitor ownership by teams
|
||||
- **MonitorUserOwner**: Manage monitor ownership by users
|
||||
- **MonitorGroup**: Organize monitors into logical groups
|
||||
- **MonitorGroupTeamOwner**: Manage group ownership by teams
|
||||
- **MonitorGroupUserOwner**: Manage group ownership by users
|
||||
- **MonitorGroupResource**: Associate monitors with groups
|
||||
- **MonitorStatusEvent**: Track monitor status change events
|
||||
- **MonitorFeed**: Monitor activity feeds and notifications
|
||||
- **MonitorLog**: Access monitor execution logs
|
||||
|
||||
### Probes
|
||||
- **Probe**: Deploy and manage monitoring probes
|
||||
- **ProbeOwnerTeam**: Manage probe ownership by teams
|
||||
- **ProbeUserOwner**: Manage probe ownership by users
|
||||
|
||||
## Incident Management
|
||||
|
||||
### Incidents
|
||||
- **Incident**: Create and manage incidents
|
||||
- **IncidentState**: Define incident states (open, investigating, resolved)
|
||||
- **IncidentFeed**: Incident activity feeds
|
||||
- **IncidentCustomField**: Add custom fields to incidents
|
||||
- **IncidentStateTimeline**: Track incident state changes over time
|
||||
- **IncidentInternalNote**: Add internal notes for team communication
|
||||
- **IncidentPublicNote**: Add public-facing notes for transparency
|
||||
- **IncidentTemplate**: Create templates for common incident types
|
||||
- **IncidentTemplateTeamOwner**: Manage template ownership by teams
|
||||
- **IncidentTemplateUserOwner**: Manage template ownership by users
|
||||
- **IncidentTeamOwner**: Assign incidents to teams
|
||||
- **IncidentUserOwner**: Assign incidents to individual users
|
||||
- **IncidentSeverity**: Define and manage incident severity levels
|
||||
- **IncidentNoteTemplate**: Create templates for incident notes
|
||||
|
||||
### Alerts
|
||||
- **Alert**: Manage alert notifications
|
||||
- **AlertState**: Define alert states
|
||||
- **AlertFeed**: Alert activity feeds
|
||||
- **AlertCustomField**: Add custom fields to alerts
|
||||
- **AlertStateTimeline**: Track alert state changes
|
||||
- **AlertInternalNote**: Internal alert notes
|
||||
- **AlertTeamOwner**: Assign alerts to teams
|
||||
- **AlertUserOwner**: Assign alerts to users
|
||||
- **AlertSeverity**: Define alert severity levels
|
||||
- **AlertNoteTemplate**: Create templates for alert notes
|
||||
|
||||
## Status Pages
|
||||
|
||||
### Status Page Management
|
||||
- **StatusPage**: Create and manage public status pages
|
||||
- **StatusPageGroup**: Organize status page components
|
||||
- **StatusPageDomain**: Configure custom domains for status pages
|
||||
- **StatusPageCustomField**: Add custom fields to status pages
|
||||
- **StatusPageResource**: Manage resources displayed on status pages
|
||||
- **StatusPageAnnouncement**: Create announcements for status pages
|
||||
- **StatusPageAnnouncementTemplate**: Templates for common announcements
|
||||
- **StatusPageSubscriber**: Manage status page subscribers
|
||||
- **StatusPageFooterLink**: Add custom footer links
|
||||
- **StatusPageHeaderLink**: Add custom header links
|
||||
- **StatusPagePrivateUser**: Manage private status page access
|
||||
- **StatusPageHistoryChartBarColor**: Customize status page chart colors
|
||||
- **StatusPageTeamOwner**: Manage status page ownership by teams
|
||||
- **StatusPageUserOwner**: Manage status page ownership by users
|
||||
- **StatusPageSSO**: Configure single sign-on for private status pages
|
||||
|
||||
## Scheduled Maintenance
|
||||
|
||||
### Maintenance Management
|
||||
- **ScheduledMaintenanceState**: Define maintenance states
|
||||
- **ScheduledMaintenanceEvent**: Create and manage maintenance windows
|
||||
- **ScheduledMaintenanceStateTimeline**: Track maintenance state changes
|
||||
- **ScheduledEventPublicNote**: Public notes for maintenance events
|
||||
- **ScheduledMaintenanceCustomField**: Custom fields for maintenance
|
||||
- **ScheduledMaintenanceFeed**: Maintenance activity feeds
|
||||
- **ScheduledMaintenanceTeamOwner**: Team ownership of maintenance events
|
||||
- **ScheduledMaintenanceUserOwner**: User ownership of maintenance events
|
||||
- **ScheduledMaintenanceTemplate**: Templates for common maintenance
|
||||
- **ScheduledMaintenanceTemplateTeamOwner**: Template team ownership
|
||||
- **ScheduledMaintenanceTemplateUserOwner**: Template user ownership
|
||||
- **ScheduledMaintenanceNoteTemplate**: Templates for maintenance notes
|
||||
|
||||
## On-Call Management
|
||||
|
||||
### On-Call Policies
|
||||
- **On-CallPolicy**: Define on-call escalation policies
|
||||
- **On-CallPolicyCustomField**: Custom fields for on-call policies
|
||||
- **EscalationRule**: Configure escalation rules
|
||||
- **TeamOn-CallDutyEscalationRule**: Team-based escalation rules
|
||||
- **User'SOn-CallDutyEscalationRule**: User-based escalation rules
|
||||
- **Schedule'SOn-CallDutyEscalationRule**: Schedule-based escalation rules
|
||||
- **On-CallDutyExecutionLog**: Logs of on-call executions
|
||||
- **On-CallDutyExecutionLogTimeline**: Timeline of on-call events
|
||||
- **UserOverride**: Temporary on-call schedule overrides
|
||||
- **OnCallDutyPolicyFeed**: On-call policy activity feeds
|
||||
- **OnCallDutyPolicyTeamOwner**: Team ownership of on-call policies
|
||||
- **OnCallDutyPolicyUserOwner**: User ownership of on-call policies
|
||||
|
||||
### Scheduling
|
||||
- **On-CallPolicySchedule**: Define on-call schedules
|
||||
- **On-CallScheduleLayer**: Create schedule layers for complex rotations
|
||||
- **On-CallScheduleLayerUser**: Assign users to schedule layers
|
||||
- **UserOn-CallLogTimeline**: Track user on-call activities
|
||||
- **OnCallTimeLog**: Log on-call time for billing/reporting
|
||||
|
||||
## Service Catalog
|
||||
|
||||
### Service Management
|
||||
- **ServiceInServiceCatalog**: Define services in your catalog
|
||||
- **ServiceCatalogTeamOwner**: Team ownership of services
|
||||
- **ServiceCatalogUserOwner**: User ownership of services
|
||||
- **ServiceDependency**: Define dependencies between services
|
||||
- **ServiceCatalogMonitor**: Associate monitors with services
|
||||
- **ServiceCatalogTelemetryService**: Link telemetry to services
|
||||
|
||||
## Workflow Automation
|
||||
|
||||
### Workflows
|
||||
- **Workflow**: Create automated workflows
|
||||
- **WorkflowVariable**: Define variables for workflows
|
||||
- **WorkflowLog**: Access workflow execution logs
|
||||
|
||||
## Telemetry and Observability
|
||||
|
||||
### Telemetry Services
|
||||
- **TelemetryService**: Manage telemetry data sources
|
||||
- **TelemetryIngestionKey**: Keys for telemetry data ingestion
|
||||
- **TelemetryAttribute**: Manage telemetry attributes
|
||||
- **Log**: Access and manage log data
|
||||
- **Span**: Distributed tracing spans
|
||||
- **Metric**: Application and infrastructure metrics
|
||||
- **MetricType**: Define custom metric types
|
||||
|
||||
### Error Tracking
|
||||
- **Exception**: Track application exceptions
|
||||
- **ExceptionInstance**: Individual exception occurrences
|
||||
|
||||
## Development and Code Analysis
|
||||
|
||||
### Code Repository Integration
|
||||
- **CodeRepository**: Connect code repositories
|
||||
- **ServiceCodeRepositoryForCopilot**: Repository configuration for Copilot
|
||||
- **CopilotEvent**: Copilot-generated events
|
||||
- **CopilotPullRequest**: Track pull requests analyzed by Copilot
|
||||
- **CopilotActionPriority**: Prioritize Copilot actions
|
||||
|
||||
## Communication and Notifications
|
||||
|
||||
### Notification Logs
|
||||
- **SMSLog**: SMS notification delivery logs
|
||||
- **CallLog**: Phone call notification logs
|
||||
- **EmailLog**: Email notification delivery logs
|
||||
- **UserNotificationLog**: User-specific notification history
|
||||
|
||||
### Workspace Communication
|
||||
- **WorkspaceNotificationRule**: Define workspace-wide notification rules
|
||||
|
||||
## UI and Customization
|
||||
|
||||
### Dashboard and Views
|
||||
- **Dashboard**: Create custom dashboards
|
||||
- **TableView**: Customize table views for resources
|
||||
- **File**: Manage uploaded files and assets
|
||||
- **Domain**: Configure custom domains
|
||||
|
||||
## Resource Operations
|
||||
|
||||
For each resource type, the MCP server typically provides these operations:
|
||||
|
||||
### Standard Operations
|
||||
- **List**: Retrieve multiple resources with filtering and pagination
|
||||
- **Count**: Get the total count of resources matching criteria
|
||||
- **Get**: Retrieve a single resource by ID
|
||||
- **Create**: Create new resources
|
||||
- **Update**: Modify existing resources
|
||||
- **Delete**: Remove resources
|
||||
|
||||
### Example Usage Patterns
|
||||
|
||||
**Resource Listing:**
|
||||
```
|
||||
"Show me all monitors" → Uses listMonitor
|
||||
"How many incidents are open?" → Uses countIncident with status filter
|
||||
```
|
||||
|
||||
**Resource Creation:**
|
||||
```
|
||||
"Create a new team called 'DevOps'" → Uses createTeam
|
||||
"Add a website monitor for example.com" → Uses createMonitor
|
||||
```
|
||||
|
||||
**Resource Management:**
|
||||
```
|
||||
"Update the timeout for monitor #123" → Uses updateMonitor
|
||||
"Delete the test probe" → Uses deleteProbe
|
||||
```
|
||||
|
||||
## Resource Relationships
|
||||
|
||||
Many resources are interconnected:
|
||||
|
||||
- **Monitors** can be owned by **Teams** and **Users**
|
||||
- **Incidents** can be assigned to **Teams** and have multiple **Notes**
|
||||
- **Status Pages** display **Resources** and can have **Announcements**
|
||||
- **On-Call Policies** include **Escalation Rules** and **Schedules**
|
||||
- **Services** can have **Dependencies** and associated **Monitors**
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [View usage examples](/docs/mcp/examples)
|
||||
- [Learn about configuration](/docs/mcp/configuration)
|
||||
- [Explore troubleshooting](/docs/mcp/troubleshooting)
|
||||
@@ -144,6 +144,17 @@ const DocsNav: NavGroup[] = [
|
||||
{ title: "Deploy LLM Server", url: "/docs/copilot/deploy-llm-server" },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: "MCP Server",
|
||||
links: [
|
||||
{ title: "Overview", url: "/docs/mcp/index" },
|
||||
{ title: "Installation", url: "/docs/mcp/installation" },
|
||||
{ title: "Quick Start", url: "/docs/mcp/quick-start" },
|
||||
{ title: "Configuration", url: "/docs/mcp/configuration" },
|
||||
{ title: "Usage Examples", url: "/docs/mcp/examples" },
|
||||
{ title: "Available Resources", url: "/docs/mcp/resources" },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: "API Reference",
|
||||
links: [
|
||||
|
||||
Reference in New Issue
Block a user