Synthetics MCP Server

Overview

The Synthetics MCP Server is a specialized monitoring solution designed to manage synthetic tests effectively. It leverages natural language prompts to create, retrieve, update, and delete synthetic tests, ensuring seamless integration with APIs like Splunk Synthetics.

Features

• Prompt-Based Test Creation: Create synthetic tests using natural language prompts.
• RESTful API: Provides endpoints for managing synthetic tests.
• Customizable: Easily extendable for additional synthetic monitoring use cases.

Project Structure

synthetics-mcp-server
├── src
│   ├── server.ts                # Entry point of the MCP server
│   ├── controllers
│   │   └── syntheticsController.ts # Handles prompt-based and CRUD operations for synthetic tests
│   ├── routes
│   │   └── syntheticsRoutes.ts     # Defines API routes for synthetic monitoring
│   ├── services
│   │   └── syntheticsService.ts     # Contains business logic for managing synthetic tests
│   ├── models
│   │   └── syntheticModel.ts        # Defines the structure of a synthetic test
│   └── utils
│       └── index.ts                 # Utility functions for the application
├── config
│   ├── default.json                 # Default configuration settings
│   └── production.json              # Production-specific configuration settings
├── package.json                     # npm configuration file
├── tsconfig.json                    # TypeScript configuration file
└── README.md                        # Project documentation

Setup Instructions

1. Clone the repository:

   git clone <repository-url>
   cd synthetics-mcp-server
   

2. Install dependencies:

   npm install
   

3. Configure the application:

   • Set the SPLUNK_API_TOKEN in the .env file for authentication.
   • Update the config/default.json file with your desired settings.

4. Start the server:

   npm start
   

API Endpoints

Prompt-Based Test Creation

• Endpoint: POST /api/synthetics/prompt
• Request Body:

  {
    "prompt": "Create a test for monitoring the homepage of https://google.com every 10 minutes."
  }
  

CRUD Operations

• Create Synthetic Test: POST /api/synthetics/create
• Retrieve Synthetic Test: GET /api/synthetics/:id
• Update Synthetic Test: PUT /api/synthetics/:id
• Delete Synthetic Test: DELETE /api/synthetics/:id

License

This project is licensed under the MIT License. See the LICENSE file for details.