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 分