MCP tool reference

create_insight

Create an insight. Requires mcp:write and the existing ConversionLab insight create policy.

Create an insight. Requires mcp:write and the existing ConversionLab insight create policy.

Permissions

{
  "ability": "mcp:write",
  "role": "The existing entity create/update policy must allow this user; write ability alone is insufficient.",
  "plan": "The billing account must have the MCP entitlement. Writes also require a writable billing mode and applicable entity limits.",
  "team": "The bearer token selects exactly one Team. Other team_id values cannot change the tenant."
}

Input

{
  "properties": {
    "project_id": {
      "description": "Project ID",
      "type": "integer"
    },
    "name": {
      "description": "Insight name",
      "maxLength": 255,
      "type": "string"
    },
    "source": {
      "description": "Optional source",
      "type": "string"
    },
    "description": {
      "description": "Optional description",
      "type": "string"
    },
    "research_collection_id": {
      "description": "Optional research collection ID",
      "type": "integer"
    },
    "insight_label_id": {
      "description": "Optional insight label ID",
      "type": "integer"
    },
    "audience_ids": {
      "description": "Optional audience IDs",
      "items": {
        "type": "integer"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "experiment_ids": {
      "description": "Optional experiment IDs",
      "items": {
        "type": "integer"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "idea_ids": {
      "description": "Optional idea IDs",
      "items": {
        "type": "integer"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "observation_ids": {
      "description": "Optional Observation IDs supporting this Insight",
      "items": {
        "type": "integer"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "page_ids": {
      "description": "Optional page IDs",
      "items": {
        "type": "integer"
      },
      "type": [
        "array",
        "null"
      ]
    }
  },
  "type": "object",
  "required": [
    "project_id",
    "name"
  ]
}

Output

{
  "type": "object",
  "properties": {
    "created": {
      "type": "boolean",
      "const": true
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "project_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "name": {
          "type": "string"
        },
        "insight_label_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "source": {
          "type": [
            "string",
            "null"
          ]
        },
        "created_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updated_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "project": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "label": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "audiences": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          }
        },
        "experiments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          }
        },
        "ideas": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          }
        },
        "pages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          }
        }
      },
      "required": [
        "id",
        "project_id",
        "name",
        "insight_label_id",
        "source",
        "created_at",
        "updated_at",
        "description",
        "project",
        "label",
        "audiences",
        "experiments",
        "ideas",
        "pages"
      ]
    }
  },
  "required": [
    "created",
    "data"
  ]
}

Examples

Request arguments

{
  "project_id": 1,
  "name": "Delivery uncertainty stops checkout"
}

Result

{
  "created": true,
  "data": {
    "id": 101,
    "project_id": 1,
    "insight_label_id": null,
    "name": "Delivery uncertainty stops checkout",
    "source": "Customer research",
    "created_at": "2026-01-15T12:00:00+00:00",
    "updated_at": "2026-01-15T12:00:00+00:00",
    "description": null,
    "project": null,
    "label": null,
    "audiences": [],
    "experiments": [],
    "ideas": [],
    "pages": []
  }
}

Errors

[
  {
    "status": 401,
    "description": "Missing, expired, or revoked bearer token."
  },
  {
    "status": 403,
    "description": "Missing MCP ability, team membership, plan entitlement, or user permission."
  },
  {
    "status": 404,
    "description": "The MCP server is disabled."
  },
  {
    "status": 429,
    "description": "Rate limited; honor Retry-After before retrying."
  },
  {
    "description": "Tool execution or validation failures are MCP error results. Inspect isError; a successful HTTP status alone does not indicate a successful tool call."
  }
]

An expired or revoked key cannot connect. A missing ability, role, feature entitlement, or team access prevents the operation. See authentication.

Was this article helpful?

Need more help? Copy this article's details and paste them into a request on our feedback portal. You may need to sign in.

Open feedback portal

On this page