Skip to main content
List messages in a conversation.

Tool details

FieldValue
Namelist_conversation_messages
GroupConversations

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "conversation_id": {
      "type": "string",
      "format": "uuid",
      "description": "Conversation identifier that scopes the request."
    },
    "cursor": {
      "type": "string",
      "description": "Opaque pagination cursor returned by a previous response."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "description": "Maximum number of results to return."
    }
  },
  "required": [
    "conversation_id"
  ],
  "additionalProperties": false,
  "description": "Input schema for the list_conversation_messages tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Message identifier."
          },
          "conversation_id": {
            "type": "string",
            "description": "Conversation identifier that owns the message."
          },
          "parent_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "Parent message identifier when the message belongs to a branch or reply chain."
          },
          "seq": {
            "type": "number",
            "description": "Monotonic sequence number within the conversation."
          },
          "role": {
            "type": "string",
            "description": "Message role such as user, assistant, tool, or system."
          },
          "created_by": {
            "type": [
              "string",
              "null"
            ],
            "description": "User or actor identifier that created the message."
          },
          "parts": {
            "type": "array",
            "items": {
              "description": "One part item associated with this record."
            },
            "description": "Structured message parts, including text, tool invocations, or rich content blocks."
          },
          "model": {
            "type": [
              "string",
              "null"
            ],
            "description": "Model identifier that generated the message, when applicable."
          },
          "token_usage": {
            "anyOf": [
              {
                "description": "The token usage associated with this record."
              },
              {
                "type": "null",
                "description": "The token usage returned by the tool."
              }
            ],
            "description": "Token accounting metadata associated with the message."
          },
          "finish_reason": {
            "type": [
              "string",
              "null"
            ],
            "description": "Completion finish reason for model-generated messages."
          },
          "cost_credits": {
            "type": [
              "string",
              "null"
            ],
            "description": "Credit cost attributed to the message, when tracked."
          },
          "status": {
            "type": "string",
            "description": "Lifecycle status of the message."
          },
          "edited_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "Timestamp when the message was edited, or null when unedited."
          },
          "idempotency_key": {
            "type": [
              "string",
              "null"
            ],
            "description": "Idempotency key used to deduplicate message creation requests."
          },
          "metadata": {
            "anyOf": [
              {
                "type": "object",
                "additionalProperties": {
                  "description": "Additional structured values associated with this result."
                },
                "description": "Additional structured metadata for the record."
              },
              {
                "type": "null",
                "description": "Additional structured metadata returned by the tool."
              }
            ],
            "description": "Additional machine-readable message metadata."
          },
          "created_at": {
            "type": "string",
            "description": "Timestamp when the message was created."
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "Timestamp when the message was last updated."
          }
        },
        "required": [
          "id",
          "conversation_id",
          "parent_id",
          "seq",
          "role",
          "created_by",
          "parts",
          "model",
          "finish_reason",
          "cost_credits",
          "status",
          "edited_at",
          "idempotency_key",
          "metadata",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false,
        "description": "Conversation message record returned by MCP conversation tools."
      },
      "description": "Message records for the requested page."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor representing the current page."
        },
        "first": {
          "type": "null",
          "description": "Always null because these MCP pagination flows do not expose a first-page cursor."
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page, or null when there are no more results."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page, or null when unavailable."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursors for the message list."
    }
  },
  "required": [
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Paginated conversation message list response.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}