MCP tool reference (Spotter 3)

const session = await callMCPTool("create_analysis_session", {
    data_source_id: "model-guid-123" // Optional. GUID of the ThoughtSpot model to query. Omit to let ThoughtSpot automatically select the most relevant data source.
});

call_mcp_tool(
    "create_analysis_session",
    {
        "data_source_id": "model-guid-123"  # Optional. GUID of the ThoughtSpot model to query.
    },
)

const sendMessage = await callMCPTool("send_session_message", {
    analytical_session_id: "sess_abc123", // Session ID from create_analysis_session.
    message: "What were total sales by region last quarter?", // User's natural language question.
    additional_context: "The user's fiscal year starts in April. " +
        "Focus on underperforming regions only." // Optional. External information to influence the analysis.
});

call_mcp_tool(
    "send_session_message",
    {
        "analytical_session_id": "sess_abc123",  # Session ID from create_analysis_session.
        "message": "What were total sales by region last quarter?", # User's natural language question.
        "additional_context": (  # Optional. External information
            "The user's fiscal year starts in April."
            "Focus on underperforming regions only." # to influence the analysis.
        ),
    },
)

const updates = await callMCPTool("get_session_updates", {
    analytical_session_id: "session-guid-abc123" // Session ID from the `create_analysis_session` call.
});

call_mcp_tool(
    "get_session_updates",
    {"analytical_session_id": "sess_abc123"},  # Session ID from create_analysis_session.
)

const dashboard = await callMCPTool("create_dashboard", {
    title: "Q4 2025 Regional Sales Analysis",
    answers: [{
            answer_id: "ans_xyz789", // answer_id from each answer-type update returned by get_session_updates.
            title: "Total Sales by Region — Q4 2025"
        },
        {
            answer_id: "ans_xyz790",
            title: "Underperforming Regions — Q4 2025 vs Q4 2024"
        }
    ],
    note_tile: "<h2 style='text-align:center;'> Q4 2025 Regional Sales Analysis</h2>" +
        "<p>Analysis of total sales by region for Q4 2025, highlighting " +
        "top-performing and underperforming regions.<br>" +
        "Generated on 2026-04-16 10:00 AM</p>" // Required. Single-line HTML string rendered as a styled summary tile at the top of the dashboard.
});

dashboard = call_mcp_tool(
    "create_dashboard",
    {
        "title": "Q4 2025 Regional Sales Analysis",
        "answers": [
            {
                "answer_id": "ans_xyz789", # answer_id from each answer-type update returned by get_session_updates.
                "title": "Total Sales by Region — Q4 2025",
            },
            {
                "answer_id": "ans_xyz790",
                "title": "Underperforming Regions — Q4 2025 vs Q4 2024",
            },
        ],
        "note_tile": (
            "<h2 style='text-align:center;'> Q4 2025 Regional Sales Analysis</h2>"
            "<p>Analysis of total sales by region for Q4 2025, highlighting "
            "top-performing and underperforming regions.<br>"
            "Generated on 2026-04-16 10:00 AM</p>"  # Required. single-line HTML string rendered as a styled summary tile at the top of the dashboard.
        ),
    },
)

const results = await callMCPTool("search_objects", {
    query: "regional sales",  // Required. Search term matched against object names and descriptions.
    types: ["LIVEBOARD", "LIVEBOARD_VIZ"], // Optional. Restrict to these object types.
    author_name: "Priya", // Optional. Case-insensitive substring match on author display name.
    tag: "Certified", // Optional. Case-insensitive substring match on tag name.
    verified_only: true, // Optional. Return only verified objects.
    limit: 5 // Optional. Maximum results to return. Defaults to 10.
});

call_mcp_tool(
    "search_objects",
    {
        "query": "regional sales", # Required. Search term matched against object names and descriptions.
        "types": ["LIVEBOARD", "LIVEBOARD_VIZ"], # Optional. Restrict to these object types.
        "author_name": "Priya", # Optional. Case-insensitive substring match on author display name.
        "tag": "Certified", # Optional. Case-insensitive substring match on tag name.
        "verified_only": True, # Optional. Return only verified objects.
        "limit": 5, # Optional. Maximum results to return. Defaults to 10.
    },
)

const result = await callMCPTool("switch_org", {
    org_id: 1002 // ID of the org to switch to, obtained from list_orgs.
});

call_mcp_tool(
    "switch_org",
    {"org_id": 1002},  # ID of the org to switch to, obtained from list_orgs.
)

const result = await callMCPTool("check_connectivity", {});

call_mcp_tool("check_connectivity", {})