add-portal-admin-api-query

Agent Skills › authgear/authgear-server › add-portal-admin-api-query

add-portal-admin-api-query

GitHub

指导在 Portal Admin 中添加 GraphQL 查询的标准流程，包括读取 schema、创建文件、处理分页及类型生成。

.claude/skills/add-portal-admin-api-query/SKILL.md authgear/authgear-server

Trigger Scenarios

需要添加 Portal Admin GraphQL 查询前端页面需要特定数据且需服务端过滤

Install

npx skills add authgear/authgear-server --skill add-portal-admin-api-query -g -y

More Options

Non-standard path

npx skills add https://github.com/authgear/authgear-server/tree/main/.claude/skills/add-portal-admin-api-query -g -y

Use without installing

npx skills use authgear/authgear-server@add-portal-admin-api-query

指定 Agent (Claude Code)

npx skills add authgear/authgear-server --skill add-portal-admin-api-query -a claude-code -g -y

安装 repo 全部 skill

npx skills add authgear/authgear-server --all -g -y

预览 repo 内 skill

npx skills add authgear/authgear-server --list

SKILL.md

Frontmatter

{
    "name": "add-portal-admin-api-query",
    "description": "Add a Portal Admin GraphQL query under portal\/src\/graphql\/adminapi\/query.",
    "argument-hint": "<query name>"
}

Follow this skill when adding a Portal Admin GraphQL query.

Workflow

Read ./portal/src/graphql/adminapi/schema.graphql first.
Create the .graphql file under ./portal/src/graphql/adminapi/query.
Include cursor, pageInfo, and totalCount when the query supports pagination and the user did not ask to omit them.
Query the fields of the entity itself, but avoid nested entities unless the user asked for them.
Fetch only the records the screen needs, filtered on the server by what it already knows (the IDs on its rows). Do not list a whole collection to pick items out on the client: page size is silently capped, usually at 100. If the schema has no such filter, stop and propose the API change instead of working around it — see "Query only the data the screen needs" in the update-portal-ui skill.
Run cd ./portal && npm run gentype after adding the file.