Tool details
| Field | Value |
|---|---|
| Name | create_conversation_message_branch |
| Group | Conversations |
Playground
Input schema
Input schema
{
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"format": "uuid",
"description": "Conversation identifier that scopes the request."
},
"message_id": {
"type": "string",
"format": "uuid",
"description": "Provide the message id."
},
"parts": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "text",
"description": "Provide the type."
},
"text": {
"type": "string",
"maxLength": 100000,
"description": "Provide the text."
}
},
"required": [
"type",
"text"
],
"additionalProperties": false,
"description": "Structured option 1 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "image",
"description": "Provide the type."
},
"upload_id": {
"type": "string",
"format": "uuid",
"description": "Provide the upload id."
},
"media_type": {
"type": "string",
"description": "Provide the media type."
},
"url": {
"type": "string",
"description": "Provide the url."
}
},
"required": [
"type",
"upload_id",
"media_type"
],
"additionalProperties": false,
"description": "Structured option 2 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "file",
"description": "Provide the type."
},
"upload_id": {
"type": "string",
"format": "uuid",
"description": "Provide the upload id."
},
"media_type": {
"type": "string",
"description": "Provide the media type."
},
"filename": {
"type": "string",
"description": "Provide the filename."
},
"url": {
"type": "string",
"description": "Provide the url."
}
},
"required": [
"type",
"media_type"
],
"additionalProperties": false,
"description": "Structured option 3 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "tool_call",
"description": "Provide the type."
},
"id": {
"type": "string",
"description": "Unique identifier for the target record."
},
"name": {
"type": "string",
"description": "Human-readable name for the target record."
},
"input": {
"type": "object",
"additionalProperties": {
"description": "Additional structured values supplied to the tool."
},
"description": "Structured input details used by the tool."
},
"state": {
"type": "string",
"enum": [
"streaming",
"pending",
"completed",
"error"
],
"description": "Provide the state."
}
},
"required": [
"type",
"id",
"name",
"input",
"state"
],
"additionalProperties": false,
"description": "Structured option 4 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "tool_result",
"description": "Provide the type."
},
"tool_call_id": {
"type": "string",
"description": "Tool call identifier that links this request to a prior tool invocation."
},
"output": {
"description": "Provide the output."
},
"is_error": {
"type": "boolean",
"description": "Provide the is error."
}
},
"required": [
"type",
"tool_call_id"
],
"additionalProperties": false,
"description": "Structured option 5 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "reasoning",
"description": "Provide the type."
},
"text": {
"type": "string",
"maxLength": 100000,
"description": "Provide the text."
},
"signature": {
"type": "string",
"description": "Provide the signature."
}
},
"required": [
"type",
"text"
],
"additionalProperties": false,
"description": "Structured option 6 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "citation",
"description": "Provide the type."
},
"source_id": {
"type": "string",
"description": "Provide the source id."
},
"url": {
"type": "string",
"description": "Provide the url."
},
"title": {
"type": "string",
"description": "Short human-readable title for the record."
},
"quote": {
"type": "string",
"description": "Provide the quote."
}
},
"required": [
"type",
"source_id"
],
"additionalProperties": false,
"description": "Structured option 7 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "source_document",
"description": "Provide the type."
},
"source_id": {
"type": "string",
"description": "Provide the source id."
},
"media_type": {
"type": "string",
"description": "Provide the media type."
},
"title": {
"type": "string",
"description": "Short human-readable title for the record."
},
"filename": {
"type": "string",
"description": "Provide the filename."
}
},
"required": [
"type",
"source_id",
"media_type",
"title"
],
"additionalProperties": false,
"description": "Structured option 8 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "step_start",
"description": "Provide the type."
}
},
"required": [
"type"
],
"additionalProperties": false,
"description": "Structured option 9 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "error",
"description": "Provide the type."
},
"code": {
"type": "string",
"description": "Provide the code."
},
"message": {
"type": "string",
"description": "Provide the message."
}
},
"required": [
"type",
"code",
"message"
],
"additionalProperties": false,
"description": "Structured option 10 details used by the tool."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "data",
"description": "Provide the type."
},
"name": {
"type": "string",
"description": "Human-readable name for the target record."
},
"value": {
"description": "Provide the value."
}
},
"required": [
"type",
"name"
],
"additionalProperties": false,
"description": "Structured option 11 details used by the tool."
}
],
"description": "One part item supplied to the tool."
},
"minItems": 1,
"maxItems": 200,
"description": "Provide one or more part values."
}
},
"required": [
"conversation_id",
"message_id",
"parts"
],
"additionalProperties": false,
"description": "Input schema for the create_conversation_message_branch tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}
Output schema
Output schema
{
"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.",
"$schema": "http://json-schema.org/draft-07/schema#"
}