.codex-plugin/plugin.json

{
  "name": "deriv",
  "version": "1.0.10",
  "description": "Live Deriv API schemas, payload validation, and guides for authentication, subscriptions, trades, and errors.",
  "author": {
    "name": "deriv",
    "email": "api-support@deriv.com",
    "url": "https://developers.deriv.com"
  },
  "homepage": "https://developers.deriv.com",
  "repository": "https://github.com/deriv-com/deriv-api-plugin",
  "license": "MIT",
  "keywords": [
    "deriv",
    "trading",
    "api",
    "websocket",
    "rest",
    "options",
    "finance",
    "fintech"
  ],
  "mcpServers": "./.mcp.json",
  "skills": "./skills/",
  "interface": {
    "displayName": "Deriv",
    "shortDescription": "Deriv API schemas and guides",
    "longDescription": "Live Deriv API schemas, payload validation, and guides for authentication, subscriptions, trades, and errors. Search endpoints, read current request and response fields, use worked examples, and validate payloads. This plugin doesn't sign in to a Deriv account, store keys, or place trades.",
    "developerName": "deriv",
    "category": "Developer Tools",
    "capabilities": [
      "Read"
    ],
    "websiteURL": "https://developers.deriv.com",
    "privacyPolicyURL": "https://deriv.com/privacy-policy",
    "termsOfServiceURL": "https://github.com/deriv-com/deriv-api-plugin/blob/master/LICENSE",
    "supportURL": "https://github.com/deriv-com/deriv-api-plugin/issues",
    "brandColor": "#FF444F",
    "defaultPrompt": [
      "Look up the live schema for a Deriv API endpoint",
      "Validate a Deriv API request payload against the live schema",
      "Set up Deriv API authentication, subscriptions, and error handling"
    ],
    "composerIcon": "./assets/logo.png",
    "logo": "./assets/logo.png",
    "logoDark": "./assets/logo-dark.png"
  },
  "extensions": {
    "com.openai": {
      "review": {
        "demo_recording_url": "https://www.youtube.com/watch?v=OfhmCFjV_2o",
        "commerce": false,
        "commerce_description": "This plugin does not sell products, process payments, offer subscriptions, or place trades.",
        "test_cases": {
          "positive": [
            {
              "description": "Find where Deriv API authentication is documented",
              "prompt": "Where is Deriv API authentication documented?",
              "tools_triggered": "search_docs",
              "expected_behavior": "Returns matching documentation pages with their listed developers.deriv.com URLs. Does not ask the reviewer to sign in."
            },
            {
              "description": "Find the endpoint used to subscribe to live tick prices",
              "prompt": "What Deriv API endpoint do I use to subscribe to live tick prices?",
              "tools_triggered": "search_endpoints",
              "expected_behavior": "Returns matching endpoint ids with summaries and source links. Does not open a live subscription or require a login."
            },
            {
              "description": "Read the live request schema for the ticks endpoint",
              "prompt": "Show me the live request schema for the Deriv ticks endpoint.",
              "tools_triggered": "get_schema",
              "expected_behavior": "Returns the published request schema and quotes the origin URL. Does not connect to a trading account."
            },
            {
              "description": "Look up the subscribe field on the ticks request",
              "prompt": "What is the subscribe field on the Deriv ticks request?",
              "tools_triggered": "get_field",
              "expected_behavior": "Returns that schema fragment and quotes the origin URL. Does not require a login."
            },
            {
              "description": "Validate a ticks request payload against the published schema",
              "prompt": "Validate this Deriv ticks request payload: {\"ticks\":\"R_100\",\"subscribe\":1}",
              "tools_triggered": "validate_payload",
              "expected_behavior": "Reports validity or schema errors against the published request schema. Does not send the payload to a live trading endpoint or require a login."
            }
          ],
          "negative": [
            {
              "description": "Legacy API call: the current Deriv API has no authorize call, so the plugin must not invent a schema for it",
              "prompt": "Show me the request schema for the Deriv authorize call.",
              "expected_behavior": "Reports that the live Deriv documentation has no authorize endpoint and does not invent a schema. It may point to the current OAuth authentication guidance instead."
            },
            {
              "description": "Field that does not exist: the Deriv buy request has no max_leverage field, so the plugin must not describe one",
              "prompt": "What does the max_leverage field on the Deriv buy request do?",
              "expected_behavior": "Reports that the live buy request schema has no max_leverage field and does not describe one from prior knowledge."
            },
            {
              "description": "Topic the docs do not cover: the Deriv API documentation has no FIX protocol page, so the plugin must not invent one",
              "prompt": "Where do the Deriv API docs explain connecting over the FIX protocol?",
              "expected_behavior": "Reports that no Deriv API documentation page covers the FIX protocol and does not invent pages or connection steps."
            }
          ]
        }
      },
      "publication": {
        "release_notes": "First directory release. Look up live Deriv API schemas, validate request payloads, and get guides for authentication, subscriptions, trades, and errors."
      }
    }
  },
  "apps": "./.app.json"
}