Home

reportmate-mcp

reportmate-mcp is a Model Context Protocol server that exposes a ReportMate device fleet to AI agents. It registers eight read-only tools over the ReportMate REST API, so an agent can answer questions like "which devices have not checked in this week?" or "what does the security module say about WS-0001?" without being handed raw database access.

It is a thin layer. Every tool is a single authenticated GET against a /api/v1/* endpoint on a ReportMate API instance you already run; the server holds no state and no database connection of its own. Mutating endpoints (archive, delete) are deliberately not registered.

Where it sits

Agents talk to reportmate-mcp; reportmate-mcp talks to reportmate-api, the same backend the dashboard and the CLI use. The device agents write into that API, so whatever the fleet has reported is what the tools return.

MCP client  ->  reportmate-mcp  ->  reportmate-api  ->  Postgres
                                        ^
                                        |
                            reportmate-client-win / -mac

Contents

• Getting Started — install, set two environment variables, run it.
• Tools Reference — every tool, its parameters, its return shape, and the upstream endpoint it calls.
• Configuration — the environment variables the server reads.
• Client Setup — Claude Desktop, Claude Code, and generic MCP client config.
• Architecture — module layout, request flow, design decisions.
• Example Prompts — fleet questions and the tools that answer them.
• Development — clone, sync, lint, test, build the image.
• Troubleshooting — failure modes and their causes.

Other ReportMate repos

Repo	Wiki	What it is
reportmate-api	wiki	FastAPI ingest + query backend; the API every tool calls
reportmate-app-web	wiki	Next.js dashboard
reportmate-client-win	wiki	Windows agent (C# / .NET), managedreportsrunner
reportmate-client-mac	wiki	macOS agent
reportmate-cli	wiki	Cross-platform admin CLI, reportmateutil
terraform-azurerm-reportmate	wiki	Azure deployment module
terraform-aws-reportmate	wiki	AWS deployment module
selfhosted-docker-reportmate	wiki	Docker Compose stack + Packer appliance
reportmate-website	wiki	Marketing site, reportmate.app