Skip to content
API Now LogoAPI Now LogoAPI Now Help Portal
API Now! is currently in closed beta. We are constantly updating these guides as we release updates!

AI Agent Custom Skills

Custom Agent Skills are pre-configured instruction sets designed for AI coding assistants. When loaded into your AI-enabled development workspace (such as VS Code or Cursor), they provide the AI with full context on API Now! architectural principles, database rules, and schema syntax.

These skills prevent the AI from hallucinating configuration properties, violating schema migration rules, or generating incorrect API paths.

Key Available Skills

Section titled “Key Available Skills”

We publish standard skills that map directly to the API Now! workspace and modeling workflow:

api-now-platform

Section titled “api-now-platform”
  • Purpose: Provides general context on the business-first, zero-code vision of the platform.
  • Rules Enforced: Guides the assistant to keep designs visual and outcome-focused, avoiding low-level coding terminology.

api-now-domain

Section titled “api-now-domain”
  • Purpose: Guides the AI on how to design database structures in the Domain Modeler.
  • Rules Enforced: Directs the assistant to apply Smart Fields first, enforce PostgreSQL column naming limits (2–59 characters, snake_case), design proper parent-to-child relationships, and avoid direct many-to-many associations.

api-now-api

Section titled “api-now-api”
  • Purpose: Guides the AI on how to design endpoint routing in the API Modeler.
  • Rules Enforced: Directs the assistant to construct secure APIs, setup RBAC role properties, avoid root-level route collisions, and configure session secret credentials.

api-now-cli

Section titled “api-now-cli”
  • Purpose: Guides the AI on how to run local tests, manage configuration properties, and coordinate files via the command line interface.
  • Rules Enforced: Restricts the assistant from running duplicate file creation uploads, directs it to perform all JavaScript and TypeScript modeling validation locally inside temporary sandboxes, and verifies authentication profiles before proposing uploads.

api-now-data-semantics

Section titled “api-now-data-semantics”
  • Purpose: Details structural rules, constraints, and data types for all available Smart Fields.
  • Rules Enforced: Instructs the assistant to select the correct primitive data types (e.g. mapping CreatedTimestamp to dates) and enforce validation formatting for properties (like country codes or currency units).

How to Find and Install Skills

Section titled “How to Find and Install Skills”

API Now! skills are published to our registry and can be searched and installed directly using the GitHub CLI:

Terminal window
# Search and install skills interactively:
gh skills search api-now

Installation Workflow

Section titled “Installation Workflow”
  1. Run the gh skills search api-now command in your terminal.
  2. The CLI will display the list of all available API Now! skills (such as api-now-platform, api-now-domain, or api-now-api).
  3. Use the arrow keys to choose the skill you wish to install from the interactive prompt, then press Enter.
  4. The CLI will automatically download and register the selected skill in your local workspace (inside your .agents/ folder).

Once installed, your AI coding assistant (operating with tools like Cursor or VS Code agents) will automatically ingest the markdown instructions and begin modeling structures that conform perfectly to the API Now! platform compiler.