Skip to main content

:::warning AUTO-GENERATED — do not edit This page is generated from the MCP server snapshot content/guide-mcp.json. Edit the source MCP server (not this file), then run npm run generate. :::

Find the right API endpoint (do this before any data work)

When to use: You need data from the backend and must confirm the exact endpoint, params, and response shape before writing code.

Prerequisites​

  • The rystad-api MCP server is connected.
  • You know the business domain you need (e.g. 'wells', 'production', 'companies', 'simulation').

Steps​

Step 1: List what backends exist so you target the right microservice.​

Tools: list_microservices

Step 2: Search for endpoints matching your domain keyword.​

Tools: search_endpoints

Step 3: Get the full contract for the chosen endpoint: params, request body, response schema.​

Tools: get_endpoint_details

Step 4: Confirm the endpoint actually exists before writing any code.​

Tools: validate_endpoint

Step 5: Get the correct gateway proxy path for this project.​

Tools: get_gateway_pattern, get_auth_requirements

Full recipe definition​

The complete machine-readable recipe as returned by the MCP server:

{
  "id": "discover-api",
  "title": "Find the right API endpoint (do this before any data work)",
  "when": "You need data from the backend and must confirm the exact endpoint, params, and response shape before writing code.",
  "prerequisites": [
    "The `rystad-api` MCP server is connected.",
    "You know the business domain you need (e.g. 'wells', 'production', 'companies', 'simulation')."
  ],
  "steps": [
    {
      "action": "List what backends exist so you target the right microservice.",
      "tools": [
        "list_microservices"
      ],
      "note": "Returns id/name/description/gatewayPath for each service (coreApiV1, dynamixApiV1, userApi, etc.)."
    },
    {
      "action": "Search for endpoints matching your domain keyword.",
      "tools": [
        "search_endpoints"
      ],
      "note": "e.g. query 'dashboard', 'simulation', 'product'. Returns {service, method, path, summary}."
    },
    {
      "action": "Get the full contract for the chosen endpoint: params, request body, response schema.",
      "tools": [
        "get_endpoint_details"
      ],
      "note": "This response schema is the ONLY allowed source for your TypeScript types."
    },
    {
      "action": "Confirm the endpoint actually exists before writing any code.",
      "tools": [
        "validate_endpoint"
      ],
      "note": "If invalid, STOP. Do not write a call to an endpoint that did not validate."
    },
    {
      "action": "Get the correct gateway proxy path for this project.",
      "tools": [
        "get_gateway_pattern",
        "get_auth_requirements"
      ],
      "note": "Use the returned apiRoute as your service BASE. All calls go through the gateway."
    }
  ],
  "filesToCreate": [],
  "validation": [
    "You can name the exact service, method, path, and every response field — each traceable to a tool call."
  ],
  "doneCriteria": [
    "Endpoint validated via `validate_endpoint`.",
    "Response schema captured for use in types."
  ],
  "commonMistakes": [
    "Guessing an endpoint path from the domain name instead of searching.",
    "Assuming REST verbs/params that were not in `get_endpoint_details`.",
    "Skipping `validate_endpoint` and writing a call to a non-existent route."
  ],
  "relatedRecipes": [
    "add-data-table",
    "wire-dynamix-simulation"
  ]
}