Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 MCP API

4 actions 4 updates phrasing extends openapi/scope3-mcp-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Scope3's API. It is a proposal applied on top of the contract, not a document Scope3 publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/'].post

$.paths['/api-call'].post

$.paths['/ask-about-capability'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Scope3 MCP API
  version: 1.0.0
extends: openapi/scope3-mcp-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an MCP session with the buyer API
      effect: write
      questions:
      - What has to happen before an agent can use the Scope3 buyer MCP tools?
      - Which protocol version does the MCP initialize handshake expect?
      - Do I need to generate my own session id when opening an MCP session?
      instructions:
      - text: Open a new MCP session using session id {session_id}.
        slots:
          session_id: header.mcp-session-id
      - text: Initialize the buyer MCP connection with client info {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api-call'].post
  update:
    x-apievangelist-phrasing:
      intent: Call a buyer REST endpoint through MCP
      effect: write
      questions:
      - Can an agent reach any buyer REST endpoint through the MCP api_call tool?
      - How do I pass a path, query parameters and a body when calling the REST API over MCP?
      instructions:
      - text: Through MCP session {session_id}, call the buyer REST endpoint described in {params}.
        slots:
          session_id: header.mcp-session-id
          params: requestBody.params
      - text: Use the MCP api_call tool to list my advertisers in session {session_id}.
        slots:
          session_id: header.mcp-session-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ask-about-capability'].post
  update:
    x-apievangelist-phrasing:
      intent: Ask a plain-language question about API features
      effect: read
      questions:
      - Can I ask the buyer API in plain English what it is able to do?
      - Is there a way for an agent to learn the API's features without reading the docs?
      instructions:
      - text: 'Ask the capability tool in session {session_id}: {params}.'
        slots:
          session_id: header.mcp-session-id
          params: requestBody.params
      - text: Find out from the MCP capability helper what I can configure on a campaign, using session {session_id}.
        slots:
          session_id: header.mcp-session-id
      method: generated
      generated: '2026-10-01'