eregulations mcp server

A Model Context Protocol (MCP) server implementation for accessing eRegulations API data. This server provides structured, AI-friendly access to eRegulations instances, making it easier for AI models to answer user questions about administrative procedures.

Features

• Access eRegulations data through a standardized protocol
• Query procedures, steps, requirements, and costs
• MCP prompt templates to guide LLM tool usage
• Streamlined implementation using standard I/O connections

Installation

# Clone the repository
git clone https://github.com/benmoumen/eregulations-mcp-server.git
cd eregulations-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

Configuration

The server can be configured using command-line arguments (preferred) or environment variables:

Command-line Arguments (Preferred)

• --api-url: URL of the eRegulations API to connect to
• --help: Show all available command-line options

Environment Variables

• EREGULATIONS_API_URL: URL of the eRegulations API to connect to (fallback if --api-url is not provided)

Note: Command-line arguments take precedence over environment variables.

Usage

Using Standard I/O

For integration with LLM systems that support MCP over standard I/O:

# Using command-line argument (preferred)
node dist/index.js --api-url https://example.com/api

# Using environment variable
EREGULATIONS_API_URL=https://example.com/api node dist/index.js

Docker Deployment

You can deploy the MCP server using Docker. Create a docker-compose.yml file:

version: '3.8'
services:
  eregulations-mcp-server:
    build: .
    command: ["--api-url", "https://example.com/api"]  # Command-line args (preferred)
    # environment:  # Alternative: environment variable
    #   - EREGULATIONS_API_URL=https://example.com/api

Then run:

# Build and start the containers
docker-compose up -d

# To stop the containers
docker-compose down

Available Tools

The MCP server provides the following tools:

listProcedures

Lists all available procedures in the eRegulations system.

getProcedureDetails

Gets detailed information about a specific procedure by its ID.

Parameters: - procedureId: ID of the procedure to retrieve

getProcedureStep

Gets information about a specific step within a procedure.

Parameters: - procedureId: ID of the procedure - stepId: ID of the step within the procedure

Prompt Templates

The server provides prompt templates to guide LLMs in using the available tools correctly. These templates explain the proper format and parameters for each tool. LLM clients that support the MCP prompt templates capability will automatically receive these templates to improve their ability to work with the API.

Development

# Run in development mode
npm run start

# Run tests
npm test

# Run tests with watch mode
npm run test:watch

# Run test client
npm run test-client

Logs

The MCP Server redirects all console output to a TCP socket to avoid interfering with the MCP protocol which requires clean JSON communication on stdout.

To view logs:

1. Start the log server in a separate terminal:

   npm run logs

2. Then run the MCP server with the MCP inspector or directly:

   npm run mcp-inspector
   # or
   npm run start

All logs will appear in the log server terminal window instead of stdout/stderr.

License

MIT