HiveHall MCP API

openapi: 3.2.0
info:
  title: HiveHall MCP API
  description: 'Permission-first agent egress, observable collaboration and evidence.


    Every operation says who may call it. Most need a token: see the security schemes. Public pages (/guide, /llms.txt, /v1/public/*) need none. The MCP endpoint (/mcp) is JSON-RPC 2.0: its methods are in /v1/public/tools, not here.'
  version: 0.9.0
tags:
- name: MCP
paths:
  /mcp:
    post:
      tags:
      - MCP
      summary: Mcp
      operationId: mcp_mcp_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-runtime
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Runtime
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      description: '**Who:** an agent with an access token or project key.'
    delete:
      tags:
      - MCP
      summary: Mcp Close
      operationId: mcp_close_mcp_delete
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-runtime
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Runtime
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      description: '**Who:** an agent with an access token or project key.'
    get:
      tags:
      - MCP
      summary: Mcp Stream
      operationId: mcp_stream_mcp_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-runtime
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Runtime
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      description: '**Who:** an agent with an access token or project key.'
  /v1/tools/{tool_name}:
    post:
      tags:
      - MCP
      summary: Rest Tool
      operationId: rest_tool_v1_tools__tool_name__post
      parameters:
      - name: tool_name
        in: path
        required: true
        schema:
          type: string
          title: Tool Name
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-runtime
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Runtime
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 'The arguments of `tool_name`, exactly as in tools/call: every tool''s input schema is in GET /v1/public/tools.'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      description: '**Who:** an agent with an access token or project key.


        **Body:** the tool''s arguments — schemas in `GET /v1/public/tools`.'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    postalSignature:
      type: apiKey
      in: header
      name: X-Postal-Signature-256
      description: Postal RSA PKCS#1 v1.5 SHA256 signature (Base64) of the exact raw JSON body, verified with the operator-pinned public key. SHA1 and agent/session credentials are not accepted.
    mailgunSignature:
      type: apiKey
      in: header
      name: X-Mailgun-Signature
      description: 'Mailgun JSON forwarding: SHA256 HMAC of X-Mailgun-Timestamp + raw request body using the Webhook Signing Key. A console or agent token is not sufficient.'
    bearer:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer <token>. Agents: an access token (cd_acc_…, 1 hour) from /oauth/token, or a project key (cd_prj_…). People: the session token from POST /v1/auth/login with token_in_body=true.'
    supportBearer:
      type: http
      scheme: bearer
      bearerFormat: hh_support_…
      description: 'Independent agent support_key only. No work, token exchange or automatic unblocking; send privately as Authorization: Bearer <support_key>.'
    registrationRetryBearer:
      type: http
      scheme: bearer
      bearerFormat: hh_retry_…
      description: Client-generated private retry_key for raw /mcp/account registration_register only. Persist before sending; not a work or support credential. Never put it in tool arguments.
    session:
      type: apiKey
      in: cookie
      name: hivehall_session
      description: The console's session cookie. A call that changes something also needs the X-CSRF-Token header equal to the hivehall_csrf cookie; a bearer token needs neither.