pmdash-mcp

A Model Context Protocol server for PMDash. It lets an AI agent read your property management KPIs — metrics, current results, history, and boards — straight from your dashboard.

Prerequisites

• Node 18+
• A PMDash API key with the read scope. In PMDash, go to Settings → API keys, create a key (read scope is enough for the tools that only read; add write for create_metric/push_metric_value). The key is shown once. See pmdash.io/developers.

Install

Requires Node 18+.

From source (no npm account needed):

git clone https://github.com/build-with-madeline/PMDash.io
cd PMDash.io/mcp
npm install
npm link          # makes `pmdash-mcp` available globally

From npm (once published):

npm install -g pmdash-mcp

Configure

Point your MCP client at the server and give it your API key. For Claude Desktop / Claude Code (mcpServers config):

{
  "mcpServers": {
    "pmdash": {
      "command": "pmdash-mcp",
      "env": {
        "PMDASH_API_KEY": "pmd_your_key_here"
      }
    }
  }
}

If you installed from source without npm link, point command at the bin directly instead:

{
  "mcpServers": {
    "pmdash": {
      "command": "node",
      "args": ["/path/to/PMDash.io/mcp/bin/pmdash-mcp.js"],
      "env": { "PMDASH_API_KEY": "pmd_your_key_here" }
    }
  }
}

PMDASH_URL is optional (defaults to https://pmdash.io).

Tools

| Tool | What it does | |------|--------------| | list_metrics | List the dashboard's metrics (id, name, source, current value, severity) | | get_metric_results | Latest computed results for every metric | | get_metric_history | Time series for one metric by id (metricId, optional days 1-365) | | list_boards | List the account's boards (each id is a boardConnectionId) | | list_metric_templates | Browse pre-built metric templates, optionally for one source (aptly, monday, appfolio, …) | | create_metric | Create a manual (trend) metric (name, optional description) — needs a write key | | push_metric_value | Set a manual metric's current value (metricId, value) — needs a write key. Refuses integration-computed metrics | | add_metric_from_template | Add a metric from a template (source, templateName; boardConnectionId for board sources, config for configurable ones) — needs a write key | | list_reports / get_report | List generated reports; fetch one with its full content | | generate_report | Generate a report now (weekly|monthly|quarterly|yearly) — needs a write key | | get_connector_format / validate_connector | Author a connector for a data source PMDash doesn't support yet: learn the manifest format, then validate a draft against the install gate. No key or credential needed — the user installs the validated manifest in PMDash |

The read tools work with any key; create_metric and push_metric_value require a key with the write scope. Issue a read-only key if you only want the agent to query.

How it works

The server authenticates with your API key over X-API-Key and calls PMDash's read endpoints, which are scoped to your client. The key is never placed in a URL or logged.

License

MIT