Populi

io.github.kisasa由 GitHub 帳號 kisasa 發布v0.2.0更新於 Oct 29, 2026

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

概覽

AI 產生的概覽

針對 Populi 學生資訊系統 API v2 的 MCP 伺服器,讓助理檢索 API 目錄、讀取人員、招生、教務與帳務資料,並可選擇性寫入。

可以做什麼
  • 在隨套件附帶的離線目錄中搜尋並檢視 API 路由、欄位、篩選條件與所需角色
  • 依篩選、expand、分頁與 all_pages 合併讀取任意 GET 路由
  • 依精確電子郵件與姓名查詢人員
  • 將 PDF、XLS、CSV 匯出、成績單與 Data Slicer 結果等檔案回應下載到本機資料夾
  • 檢視實例、金鑰類型、寫入狀態與逾時,並可用一次即時請求驗證金鑰
  • 僅在明確開啟寫入時,透過任意路由建立、更新、刪除或上傳檔案
適用情境
適合助理需要查詢或彙整某個 Populi 學校實例中的人員、招生、教務、帳務資料,或進行受控變更時使用,建議先在沙箱實例上試用。
執行需求
透過 npx 以 stdio 本機程序執行,需要 Node.js 20 或更新版本。需要 POPULI_BASE_URL(https 實例網址)與 POPULI_API_KEY(在 Populi 帳戶設定中建立的 API 金鑰)。選用:POPULI_ALLOW_WRITES、POPULI_FILES_DIR、POPULI_TIMEOUT_MS。需要能連線至該實例的網路;API 目錄可離線使用。
安裝前請注意
API 金鑰依其 Populi 角色決定可見範圍,應使用最小權限角色。學生紀錄可能包含社會安全碼、出生日期、成績與助學金資訊,工具回傳內容會傳送給你的模型供應商。寫入預設關閉;開啟 POPULI_ALLOW_WRITES 後會提供建立、更新與刪除,且 Populi 中的 DELETE 為永久刪除。上傳與下載僅限 POPULI_FILES_DIR,超過 100 MB 的檔案會被拒絕。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Populi,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

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_downloadGET a route and save the response to a file instead of returning it. For PDF/XLS/CSV exports, transcripts, Data Slicer results, file and backup downloads, and for keeping a large export out of the conversation.
populi_find_peopleLook up people by exact email and/or name.
populi_statusShows the instance, key type (sandbox or live), whether writes are on, the files folder and the timeout. verify: true makes one live request to check the key.
populi_writePOST / PUT / DELETE any route, including multipart file uploads. Only exists when POPULI_ALLOW_WRITES=true.

Together they cover the whole API: all 492 documented GET routes, all 205 write routes, file uploads and file downloads. Routes that aren't in the bundled catalog work too, since the tools take any path.

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.
POPULI_FILES_DIRnoThe one folder downloads are saved to and uploads are read from. Default: ~/populi-mcp-files.
POPULI_TIMEOUT_MSnoHow long one Populi request may take, 1000 to 600000. Default: 120000 (two minutes). Each call can also pass timeout_ms.

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

bash
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\):

json
{  "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

bash
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:

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:

json
{  "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 call returns an error with how long to wait, and later calls fail fast with the remaining wait instead of hammering a limited key. Prefer one filtered call over many unfiltered ones.
  • One request at a time. Populi allows a single "heavy" call (Data Slicer, big exports) at once, so the server runs requests sequentially even if the client sends several in parallel.
  • Pages. Lists return at most 200 records. all_pages follows every page up to 500 pages, stopping once max_records (default 500, up to 1,000,000) is reached. The page that crosses the limit is kept whole, so nothing is dropped. The result says whether it completed and otherwise gives a next_page to resume from. If a rate limit or timeout hits part-way, the pages already fetched are returned, not thrown away.
  • 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. If that would make the URL longer than about 7 KB (for example a filter listing thousands of ids), the request is sent as a GET with a JSON body instead, which Populi documents as the normal form. POST/PUT/DELETE send a JSON body.
  • Large responses from populi_get are truncated at max_chars (default 40,000, up to 1,000,000) with a note on how to narrow the request. Use populi_download to save the whole thing to a file instead.
  • File downloads. Routes that return a file (PDF/XLS/CSV exports, transcripts, Data Slicer results, file downloads) are fetched with populi_download, which writes into the files folder. It never overwrites (an existing name gets -1, -2, ...), and only uses names, never paths, so it can't write outside the folder. populi_get describes a file response but can't show it.
  • File uploads. populi_write takes files, each either a path inside the files folder or content_base64. They are sent as multipart/form-data with the file as file and the other fields as a JSON parameters part, which is how Populi's upload routes (/people/{id}/upload_file, /people/{id}/update_profile_picture, /libraryresources/{id}/update_image, /libraryresources/{id}/digitalresources/upload) expect them. As a safety cap, this server refuses files over 100 MB.
  • The files folder is a boundary. A model can only read uploads from, and save downloads to, POPULI_FILES_DIR. Paths that leave it, including through symlinks, are refused, so a prompt-injected "upload my SSH key" has nothing to read. Point it at a broader folder only if you want that.
  • Timeouts. Populi publishes no timeout, and reports such as Data Slicer can be slow, so the default is two minutes. Your MCP client may enforce its own tool timeout as well, which this server can't raise; check its settings if a long report is cut off.
  • 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

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

Try it against a real instance:

bash
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):

bash
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.

來源:README.md,提交 63047da

工具

0
SourceWeft 尚未在沙箱中啟動過該軟體包,因此其工具未知。

版本歷史

1
  1. v0.2.0最新Oct 29, 2026

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分