MCP tool reference

list_experiment_states

List experiment states, optionally filtered by project.

List experiment states, optionally filtered by project.

Permissions

{
  "ability": "mcp:read or mcp:write",
  "role": "Team membership and applicable entity view policies are required.",
  "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": "Optional project ID filter",
      "type": "integer"
    }
  },
  "type": "object"
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "project_id": {
            "type": [
              "integer",
              "null"
            ]
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "category": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "draft",
              "live",
              "paused",
              "finished",
              "archived",
              null
            ]
          },
          "order": {
            "type": [
              "integer",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "project_id",
          "name",
          "description",
          "category",
          "order"
        ]
      }
    }
  },
  "required": [
    "data"
  ]
}

Examples

Request arguments

{}

Result

{
  "data": [
    {
      "id": 101,
      "project_id": 1,
      "name": "Planned",
      "description": null,
      "category": null,
      "order": 1
    }
  ]
}

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