Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints MCP API

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

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/mcp/auth/required'].get

$.paths['/mcp/user/auth/upsert'].post

$.paths['/mcp/user/auth/delete'].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 Relevance AI Endpoints MCP API
  version: 1.0.0
extends: openapi/relevance-ai-mcp-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/mcp/auth/required'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which MCP servers need my login
      effect: read
      questions:
      - Which MCP servers used by an agent still need me to authenticate?
      - Do I have OAuth or API key credentials set up for every MCP server my agent uses?
      instructions:
      - text: Check which MCP servers in agent {agent_id} need my authentication.
        slots:
          agent_id: query.agent_id
      - text: Tell me which MCP servers I haven't connected credentials to yet for agent {agent_id}.
        slots:
          agent_id: query.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mcp/user/auth/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Save my credentials for an MCP server
      effect: write
      questions:
      - How do I give an MCP server my API key or custom headers?
      - Can I update the OAuth account I use for an MCP server?
      instructions:
      - text: Set my auth for MCP server {mcp_server_display_id} to {auth_details}.
        slots:
          mcp_server_display_id: requestBody.mcp_server_display_id
          auth_details: requestBody.auth_details
      - text: Update the API key I use with MCP server {mcp_server_display_id} using {auth_details}.
        slots:
          mcp_server_display_id: requestBody.mcp_server_display_id
          auth_details: requestBody.auth_details
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mcp/user/auth/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove my credentials for an MCP server
      effect: destructive
      questions:
      - How do I disconnect my credentials from an MCP server?
      - What happens if I remove MCP server credentials that were never set?
      instructions:
      - text: Remove my authentication for MCP server {mcp_server_display_id}.
        slots:
          mcp_server_display_id: requestBody.mcp_server_display_id
      - text: Forget the API key I stored for MCP server {mcp_server_display_id}.
        slots:
          mcp_server_display_id: requestBody.mcp_server_display_id
      method: generated
      generated: '2026-09-26'