Fantasy Pundit Commentary API

openapi: 3.2.0
info:
  title: Fantasy Pundit Public Commentary API
  version: 0.9.0
  description: Retrieve, reserve, or request one canonical written commentary for the current available Fantasy Premier League mini-league Gameweek. No Fantasy Pundit account or OAuth is required.
servers:
- url: https://api.fantasypundit.lol
tags:
- name: Commentary
  description: Canonical weekly commentary.
paths:
  /api/jobs/commentary:
    post:
      operationId: requestWeeklyCommentary
      summary: Request canonical weekly commentary
      description: Returns an existing equivalent job or requests the single written edition for the current available Gameweek. At full-time, the request can wait until FPL scoring is ready before writing begins, and may start before FPL changes the public Gameweek label. Repeating the same request does not create a variant.
      tags:
      - Commentary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentaryRequest'
            examples:
              leagueId:
                value:
                  leagueId: '314'
              leagueUrl:
                value:
                  leagueId: https://fantasy.premierleague.com/leagues/314/standings/c
      responses:
        '200':
          description: An equivalent completed or active job already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentaryJobAccepted'
        '202':
          description: The canonical edition is saved, queued, or processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentaryJobAccepted'
        '400':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/RateLimitedError'
  /api/jobs/{jobId}:
    get:
      operationId: getCommentaryJob
      summary: Read a commentary job
      description: Poll until the job is completed or failed. A completed response contains the written commentary and durable links.
      tags:
      - Commentary
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      responses:
        '200':
          description: Current job state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentaryJob'
        '404':
          $ref: '#/components/responses/Error'
  /mcp:
    post:
      operationId: callMcp
      summary: Connect an MCP-capable client
      description: Streamable HTTP MCP endpoint. Use the three canonical tools listed in x-fantasy-pundit-mcp.
      tags:
      - Commentary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: MCP response or stream.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
            text/event-stream:
              schema:
                type: string
components:
  responses:
    RateLimitedError:
      description: New work is temporarily rate limited or at capacity. Existing editions remain readable.
      headers:
        Retry-After:
          description: Minimum whole seconds to wait before retrying the same write request.
          schema:
            type: integer
            minimum: 1
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: The request could not be completed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    CommentaryJob:
      type: object
      required:
      - id
      - status
      - progress
      - leagueId
      properties:
        id:
          type: string
        status:
          type: string
          enum:
          - queued
          - processing
          - completed
          - failed
        progress:
          type: integer
          minimum: 0
          maximum: 100
        leagueId:
          type: string
        gameweek:
          type:
          - integer
          - 'null'
          minimum: 1
          maximum: 38
        deferredUntilFinal:
          type: boolean
        pollAfterSeconds:
          type: integer
          minimum: 2
        commentary:
          description: The complete published commentary when status is completed.
          type:
          - object
          - 'null'
          additionalProperties: true
        leagueUrl:
          type:
          - string
          - 'null'
          format: uri
        textShareUrl:
          type:
          - string
          - 'null'
          format: uri
        error:
          oneOf:
          - $ref: '#/components/schemas/Error'
          - type: 'null'
      additionalProperties: true
    CommentaryRequest:
      type: object
      required:
      - leagueId
      properties:
        leagueId:
          type: string
          minLength: 1
          description: A numeric public classic-league ID or public FPL classic-league URL.
      additionalProperties: false
    Error:
      type: object
      required:
      - error
      properties:
        code:
          type: string
        error:
          type: string
        retryAfterSeconds:
          type: integer
          minimum: 1
          description: Minimum whole seconds to wait before retrying the same write request.
        resetAt:
          type: string
          format: date-time
          description: The earliest advertised time to retry the same write request.
      additionalProperties: false
    CommentaryJobAccepted:
      type: object
      required:
      - jobId
      - status
      - deduplicated
      - gameweek
      properties:
        jobId:
          type: string
        status:
          type: string
          enum:
          - queued
          - processing
          - completed
        deduplicated:
          type: boolean
        gameweek:
          type: integer
          minimum: 1
          maximum: 38
        seasonId:
          type: string
        deferredUntilFinal:
          type: boolean
          description: True when the full-time request is saved until FPL scoring is ready.
        pollAfterSeconds:
          type: integer
          minimum: 2
      additionalProperties: true
externalDocs:
  description: Fantasy Pundit integration guide
  url: https://fantasypundit.lol/docs/
x-fantasy-pundit-mcp:
  url: https://api.fantasypundit.lol/mcp
  version: 0.9.0
  protocolVersions:
  - '2026-07-28'
  - '2025-11-25'
  - '2025-06-18'
  - '2025-03-26'
  discoveryMethod: server/discover
  authentication: none
  documentationResources:
  - fantasy-pundit://guide/weekly-commentary
  - fantasy-pundit://guide/capabilities
  optionalExperiences:
  - league_selection_form
  - embedded_edition_card
  toolSchemas: Read tools/list for the live input and output schemas, nextStep values and polling guidance.
  canonicalTools:
  - name: get_league_commentary
    purpose: Read an existing canonical weekly commentary and league roast without starting generation.
    annotations:
      readOnlyHint: true
      destructiveHint: false
      idempotentHint: true
      openWorldHint: true
  - name: generate_weekly_commentary
    purpose: Create or reuse the canonical weekly commentary and league roast after an explicit user request. Optional gameweek guards the expected current week and refuses a stale request.
    annotations:
      readOnlyHint: false
      destructiveHint: false
      idempotentHint: true
      openWorldHint: true
  - name: get_commentary_result
    purpose: Check a queued league-roast job and return its exact commentary and links.
    annotations:
      readOnlyHint: true
      destructiveHint: false
      idempotentHint: true
      openWorldHint: true