Populi

Registre officiel Recherche et web

Populi API v2 for student information systems: search the API, read data, optionally write

Installation

Ajoutez ceci à la configuration MCP de votre client (Claude Desktop : claude_desktop_config.json ; Cursor : .cursor/mcp.json ; VS Code et les autres utilisent la même forme « mcpServers »).

NPM package @kisasa/populi-mcp
Claude Code
claude mcp add populi -e 'POPULI_BASE_URL=<POPULI_BASE_URL>' -e 'POPULI_API_KEY=<your populi_api_key>' -e 'POPULI_ALLOW_WRITES=false' -e 'POPULI_FILES_DIR=<POPULI_FILES_DIR>' -e 'POPULI_TIMEOUT_MS=120000' -- npx -y @kisasa/populi-mcp@0.2.0
Configuration JSON (Claude Desktop, Cursor, VS Code)
{
    "mcpServers": {
        "populi": {
            "command": "npx",
            "args": [
                "-y",
                "@kisasa/populi-mcp@0.2.0"
            ],
            "env": {
                "POPULI_BASE_URL": "<POPULI_BASE_URL>",
                "POPULI_API_KEY": "<your populi_api_key>",
                "POPULI_ALLOW_WRITES": "false",
                "POPULI_FILES_DIR": "<POPULI_FILES_DIR>",
                "POPULI_TIMEOUT_MS": "120000"
            }
        }
    }
}

Variables d'environnement

  • POPULI_BASE_URL obligatoire Your Populi instance URL, with or without the /api2 suffix
  • POPULI_API_KEY obligatoire secret Populi API key token (Account & Settings > API > Keys). Use an sk_sandbox_ key against a sandbox instance while evaluating
  • POPULI_ALLOW_WRITES Set to true to enable the populi_write tool (create, update, delete). Default is read-only
  • POPULI_FILES_DIR Folder for downloads and uploads (the only place files are read from or written to). Default ~/populi-mcp-files
  • POPULI_TIMEOUT_MS Per-request timeout in milliseconds, 1000 to 600000. Default 120000

Documentation

Tirée du README du projet sur GitHub, actualisée chaque semaine. Les liens ouvrent GitHub.

Sommaire
  1. populi-mcp
  2. How it works
  3. Configuration
  4. Install
  5. API behaviors worth knowing
  6. Development
  7. License

populi-mcp

MCP server for the Populi API v2. It lets Claude, Codex, Cursor and any other Model Context Protocol client look up people, admissions, academics and billing data in your Populi instance, and, if you opt in, make changes.

Package: @kisasa/populi-mcp on npm. Command: populi-mcp. Transport: stdio.

How it works

Populi's API has 697 routes across 180 models. Exposing each as its own tool would flood a model's context, so this server gives the model a small toolset plus the API reference itself:

ToolWhat it does
populi_search_apiKeyword search over the bundled route catalog (applications, invoice, enrollments, ...).
populi_describe_apiFull reference for one route: path ids, required and optional fields with types, expand options, filter conditions, required Populi roles, docs link.
populi_getGET any route. Supports filter, expand, page, limit, and all_pages to merge every page into one list.
populi_find_peopleLook up people by exact email and/or name.
populi_statusShows the instance, key type (sandbox or live) and whether writes are on. verify: true makes one live request to check the key.
populi_writePOST / PUT / DELETE any route. Only exists when POPULI_ALLOW_WRITES=true.

A typical exchange: the model searches for the route, reads its parameters, then calls populi_get with a server-side filter.

The catalog is generated from the public API docs and ships inside the package, so searching and describing work offline and cost no API requests.

Configuration

VariableRequiredDescription
POPULI_BASE_URLyesYour instance, e.g. https://yourschool.populiweb.com. A trailing /api2 is fine and optional. Must be https.
POPULI_API_KEYyesAn API key token. In Populi: Account & Settings > API > Keys (Account Administrator). Sent as a bearer token to POPULI_BASE_URL only.
POPULI_ALLOW_WRITESnoSet to true to enable populi_write. Default: read-only.

The key's Populi roles decide what it can see. A route the key cannot reach returns a 403 naming the problem; populi_describe_api lists the roles each route needs.

Sandbox first

Populi issues separate sk_sandbox_... keys that only work against sandbox instances (live keys only work on live). Point this server at a sandbox while you evaluate it.

Read-only by default

With no POPULI_ALLOW_WRITES, the write tool is not registered at all, so the model cannot even attempt a change. When you enable it, populi_write is marked destructive, so clients that prompt for approval will ask before each call. DELETE in Populi is permanent.

Install

Requires Node.js 20 or newer. Every client below runs npx -y @kisasa/populi-mcp, so there is nothing to install by hand.

Claude Code
claude mcp add populi \
  -e POPULI_BASE_URL=https://yourschool.populiweb.com \
  -e POPULI_API_KEY=sk_sandbox_... \
  -- npx -y @kisasa/populi-mcp
Claude Desktop

Edit claude_desktop_config.json (macOS: ~/Library/Application Support/Claude/, Windows: %APPDATA%\Claude\):

{
  "mcpServers": {
    "populi": {
      "command": "npx",
      "args": ["-y", "@kisasa/populi-mcp"],
      "env": {
        "POPULI_BASE_URL": "https://yourschool.populiweb.com",
        "POPULI_API_KEY": "sk_sandbox_..."
      }
    }
  }
}

On Windows, if Claude Desktop cannot find npx, use "command": "cmd" with "args": ["/c", "npx", "-y", "@kisasa/populi-mcp"].

Codex
codex mcp add populi \
  --env POPULI_BASE_URL=https://yourschool.populiweb.com \
  --env POPULI_API_KEY=sk_sandbox_... \
  -- npx -y @kisasa/populi-mcp

or in ~/.codex/config.toml:

[mcp_servers.populi]
command = "npx"
args = ["-y", "@kisasa/populi-mcp"]

[mcp_servers.populi.env]
POPULI_BASE_URL = "https://yourschool.populiweb.com"
POPULI_API_KEY = "sk_sandbox_..."
Cursor

In .cursor/mcp.json (project) or ~/.cursor/mcp.json (global). Cursor expands ${env:NAME}, which keeps the key out of the file:

{
  "mcpServers": {
    "populi": {
      "command": "npx",
      "args": ["-y", "@kisasa/populi-mcp"],
      "env": {
        "POPULI_BASE_URL": "https://yourschool.populiweb.com",
        "POPULI_API_KEY": "${env:POPULI_API_KEY}"
      }
    }
  }
}
Any other MCP client

Run npx -y @kisasa/populi-mcp as a stdio server with POPULI_BASE_URL and POPULI_API_KEY in its environment.

More than one instance

Add one entry per instance under different names (populi-sandbox, populi-live), each with its own key.

API behaviors worth knowing

  • Rate limits. 50 requests/min per key from 3AM-7PM PST, 100/min overnight, plus per-IP and per-school limits. On HTTP 429 the tool returns an error telling the model how long to wait instead of blocking. Prefer one filtered call over many unfiltered ones.
  • Pages. Lists return at most 200 records. all_pages merges pages up to max_records (default 500) and reports whether it got everything.
  • Filters. Populi ignores filter field names it does not know and returns the whole list, which looks like "everyone matches". populi_describe_api lists the valid condition names for a route; populi_find_people uses the right ones for people.
  • GET parameters. filter, expand, page and limit travel in a parameters query value, because most HTTP clients cannot send a GET body. POST/PUT/DELETE send a JSON body.
  • Large responses are truncated at max_chars (default 40,000) with a note on how to narrow the request.
  • File downloads (CSV, XLS, PDF): text formats are returned as text; binary files are reported by size only.
  • Student data is sensitive. Records can include SSNs, birthdates, grades and financial aid. The server never logs request or response bodies, and the key is never echoed in errors, but whatever a tool returns goes to your model provider. Use the narrowest key role and expand you need.

Development

git clone https://github.com/kisasa/populi-mcp.git
cd populi-mcp
npm install
npm run build      # compile to dist/
npm test           # unit + in-memory MCP tests, no network

Try it against a real instance:

POPULI_BASE_URL=https://yourschool.populiweb.com POPULI_API_KEY=sk_sandbox_... \
  npx @modelcontextprotocol/inspector node dist/index.js
Refreshing the API catalog

data/catalog.json is scraped from the rendered API docs (Populi publishes no OpenAPI file):

npm run build:catalog

Review and commit the diff when Populi ships API changes.

Releasing

Publishing is automated by .github/workflows/publish.yml on every push to main, and only acts when the version is new. To release:

  1. Bump version in package.json and both version fields in server.json.
  2. Merge to main. The workflow publishes to npm (with provenance), the MCP Registry as io.github.kisasa/populi-mcp, and creates a GitHub release.

npm authentication uses trusted publishing if configured for this repo, otherwise the NPM_TOKEN repository secret.

License

MIT. Not affiliated with Populi. "Populi" is a trademark of its owner.

Questions fréquentes

Qu'est-ce que Populi ?

Populi API v2 for student information systems: search the API, read data, optionally write

Comment installer Populi ?

Il s'exécute sur votre machine. Dans Claude Code : claude mcp add populi -e 'POPULI_BASE_URL=<POPULI_BASE_URL>' -e 'POPULI_API_KEY=<your populi_api_key>' -e 'POPULI_ALLOW_WRITES=false' -e 'POPULI_FILES_DIR=<POPULI_FILES_DIR>' -e 'POPULI_TIMEOUT_MS=120000' -- npx -y @kisasa/populi-mcp@0.2.0. Pour les autres clients, collez la configuration JSON de cette page dans leurs réglages MCP.

Faut-il une clé API pour Populi ?

Oui. Il attend POPULI_BASE_URL, POPULI_API_KEY, à renseigner dans sa configuration.

Populi est-il open source ?

Oui. Son code est sur GitHub sous licence MIT.

Qui maintient Populi ?

Il est publié par kisasa. AI.tn le référence sans le maintenir ni le recommander.

Issu du registre MCP officiel. Être listé n'est pas une recommandation : vérifiez le code et les permissions d'un serveur avant de lui donner accès à vos données.