Repository navigation
Getting Started
The shortest path from nothing to an agent that can answer questions about your fleet. You need a running ReportMate API and a credential for it; this server does not talk to a database directly.
Either a scoped API key (preferred) or the shared client passphrase your API is
configured with. The server only issues GET requests, so a read-scoped key is
enough. See Configuration for how the two are used.
From a clone, using uv:
git clone https://github.com/reportmate/reportmate-mcp
cd reportmate-mcp
uv sync
uv sync leaves the reportmate-mcp command inside the clone's virtual
environment, reachable through uv run. To put it on your PATH, which the
client examples assume, install it as a uv tool instead:
uv tool install git+https://github.com/reportmate/reportmate-mcp
Or pull the published image:
docker pull ghcr.io/reportmate/reportmate-mcp
export REPORTMATE_API_URL=https://reportmate.example.com
export REPORTMATE_API_KEY=rm_yourclient_yoursecret
uv run reportmate-mcp
The process starts and waits silently. That is correct: it speaks MCP over stdio
and expects a client on the other end. If your environment is wrong you will see
REPORTMATE_API_URL not set or no credential instead — but note those are
raised lazily, on the first tool call, not at startup.
Press Ctrl-C and move on.
Follow Client Setup for Claude Desktop, Claude Code, or a generic client.
The short version for Claude Code, with reportmate-mcp on your PATH:
claude mcp add reportmate \
-e REPORTMATE_API_URL=https://reportmate.example.com \
-e REPORTMATE_API_KEY=rm_yourclient_yoursecret \
-- reportmate-mcp
Start with the health check, which proves the URL is right, then a summary, which proves the credential is:
Use the reportmate tools to check the API health, then give me a fleet summary.
From there, Example Prompts has questions worth asking, and Tools Reference documents what each tool returns.
AGPL-3.0-or-later — a commercial license is also available. reportmate.app