@omnixdp/agent-instructions

Generate Cursor, GitHub Copilot, Claude, and generic coding-agent instructions from live Omni xDP schemas and API capability manifests.

Install

npm install -D @omnixdp/agent-instructions

Generate

npx omnixdp-agent-instructions sync --config omnixdp.agent.config.js

The command loads .env and .env.local, exchanges configured client credentials for short-lived access tokens, fetches Omni xDP /agent-manifest endpoints, and writes:

• .omnixdp/agent-manifest.json
• .omnixdp/agent-instructions.md
• .cursor/rules/omnixdp-data.mdc
• .github/copilot-instructions.md
• CLAUDE.md
• AGENTS.md

Shared Markdown targets are updated inside generated marker blocks so local project guidance can live outside the generated section.

Check in CI

npx omnixdp-agent-instructions sync --config omnixdp.agent.config.js --check

--check fails when any generated instruction file is stale.

Config File

module.exports = {
  apiUrl: process.env.NEXT_PUBLIC_OMNIXDP_API_URL ?? process.env.OMNIXDP_API_URL,
  managementClientId: process.env.OMNIXDP_MANAGEMENT_CLIENT_ID,
  managementClientSecret: process.env.OMNIXDP_MANAGEMENT_CLIENT_SECRET,
  businessObjectsClientId: process.env.OMNIXDP_BO_CLIENT_ID,
  businessObjectsClientSecret: process.env.OMNIXDP_BO_CLIENT_SECRET,
  ratingsAndReviewsClientId: process.env.OMNIXDP_RR_CLIENT_ID,
  ratingsAndReviewsClientSecret: process.env.OMNIXDP_RR_CLIENT_SECRET,
  impexClientId: process.env.OMNIXDP_IMPEX_CLIENT_ID,
  impexClientSecret: process.env.OMNIXDP_IMPEX_CLIENT_SECRET,
  cmsSpace: process.env.NEXT_PUBLIC_OMNIXDP_CMS_SPACE ?? process.env.OMNIXDP_CMS_SPACE,
  boSpace: process.env.OMNIXDP_BO_SPACE,
  rrSpace: process.env.OMNIXDP_RR_SPACE
};

Generated instructions tell coding agents that Delivery uses NEXT_PUBLIC_OMNIXDP_* values before private OMNIXDP_* values, that private Delivery variables belong in server code only, and that generated Next.js apps can expose public SEO/AEO/GEO discovery content through /llms.txt and *.html.md.

Do not store real secrets in generated instruction files. The generator only writes scope names, API identifiers, model structures, and action metadata.