OpenParable
Skip to content
← Back to skills

Add Portal Admin API Query

Development
add-portal-admin-api-query

Add Portal Admin API Query is an Agent Skill for development published in the authgear/authgear-server repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Add a Portal Admin GraphQL query under portal/src/graphql/adminapi/query.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/authgear/authgear-server/blob/HEAD/.claude/skills/add-portal-admin-api-query/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/add-portal-admin-api-query, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Follow this skill when adding a Portal Admin GraphQL query.

Workflow

  1. Read ./portal/src/graphql/adminapi/schema.graphql first.
  2. Create the .graphql file under ./portal/src/graphql/adminapi/query.
  3. Include cursor, pageInfo, and totalCount when the query supports pagination and the user did not ask to omit them.
  4. Query the fields of the entity itself, but avoid nested entities unless the user asked for them.
  5. Run cd ./portal && npm run gentype after adding the file.

Notes

  • Keep the operation name consistent with existing Portal GraphQL naming.
  • Do not invent schema fields; use only what exists in the schema file.