From 45b3f3b1d20aa89913b7a1f1217c257310c72eb0 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Wed, 22 Jul 2026 16:51:12 +0530 Subject: [PATCH 1/6] spottercode auth updates --- .../ROOT/pages/spottercode-integration.adoc | 91 ++++++++++++++++++- modules/ROOT/pages/spottercode.adoc | 22 +++-- modules/ROOT/pages/whats-new.adoc | 10 ++ 3 files changed, 115 insertions(+), 8 deletions(-) diff --git a/modules/ROOT/pages/spottercode-integration.adoc b/modules/ROOT/pages/spottercode-integration.adoc index 31209817e..232723a5e 100644 --- a/modules/ROOT/pages/spottercode-integration.adoc +++ b/modules/ROOT/pages/spottercode-integration.adoc @@ -15,6 +15,95 @@ This guide walks you through the process of adding SpotterCode to your IDE. * Ensure that the latest version of Node.js is installed in your environment. This is required for building embedding code with the SDK. * Ensure that you have access to a ThoughtSpot instance and can view the objects and resources that you want to embed or access via the REST API. +[#_authenticate_spottercode] +== Authenticating to SpotterCode +The SpotterCode MCP Server at `https://spottercode.thoughtspot.app/mcp` requires authentication. Authentication enables SpotterCode to make API calls to your ThoughtSpot instance on your behalf, which is required to use the `run-ts-workflow` skill for tasks such as generating secret keys, configuring CORS and CSP allowlists, and fetching object IDs. + +SpotterCode supports two authentication mechanisms: + +* OAuth and SAML authentication +* Bearer token authentication + +=== OAuth and SAML authentication + +This is the primary authentication flow for developers connecting an MCP client interactively. + +. When your MCP client connects to the `https://spottercode.thoughtspot.app/mcp` endpoint for the first time, a dialog appears requesting your ThoughtSpot instance URL. +. Enter your ThoughtSpot instance URL (for example, `https://your-org.thoughtspot.cloud`). +. You are redirected to the ThoughtSpot SAML login flow for your instance. +. After successful login, SpotterCode obtains a bearer token for your session and stores the session information securely. +. Subsequent MCP requests from your IDE agent use the session token automatically and you will not be prompted to log in again until the session expires. + +[NOTE] +==== +The session token is stored in a secure backend store. Contact your ThoughtSpot administrator if you encounter repeated authentication prompts. +==== + +=== Bearer token authentication +For programmatic or CI/CD scenarios where an MCP client cannot perform an interactive login, SpotterCode accepts a bearer token directly. + +In your MCP client configuration, pass the `Authorization` header in the following format: + +[source,text] +---- +Authorization: Bearer @ +---- + +Where: + +* `` is a valid ThoughtSpot bearer token obtained from the ThoughtSpot REST API. +* `` is your ThoughtSpot instance hostname (for example, `your-org.thoughtspot.cloud`). + +SpotterCode extracts and validates the token and host, then injects the authentication context into each MCP tool request. + +[TIP] +==== +To obtain a bearer token, use the xref:authentication.adoc[ThoughtSpot REST API v2 authentication endpoints] or trusted authentication. For more information, see xref:trusted-authentication.adoc[Trusted authentication]. +==== + +=== MCP Server endpoint for documentation retrieval + +If you only need documentation and REST API reference retrieval, use the following MCP Server URL which unauthenticated endpoint: + +---- +`\https://spottercode.thoughtspot.app/mcp/docs` +---- + +This endpoint provides access to the `get-rest-api-reference` and `get-developer-docs-reference` skills only. The `run-ts-workflow` skill is not available through this endpoint. + +To use this endpoint in your IDE, replace the authenticated MCP server URL in your configuration: + +For Cursor (`mcp.json`):: +[source,JSON] +---- +{ + "mcpServers": { + "SpotterCode": { + "url": "https://spottercode.thoughtspot.app/mcp/docs" + } + } +} +---- + +For Claude Code (CLI):: +[source,Bash] +---- +claude mcp add --transport http SpotterCode https://spottercode.thoughtspot.app/mcp/docs +---- + +For Visual Studio Code (`mcp.json`):: +[source,JSON] +---- +{ + "servers": { + "SpotterCode": { + "url": "https://spottercode.thoughtspot.app/mcp/docs", + "type": "http" + } + } +} +---- + == Integrate SpotterCode with Cursor You can add the SpotterCode MCP Server URL to Cursor using the one-click installation link or the `mcp.json` file. @@ -74,7 +163,7 @@ To add SpotterCode as a custom connector: . Go to **Customize** > **Connectors** . Click the `+` icon and select **Add custom connector**. -. Enter the SpotterCode MCP server URL: `https://spottercode.thoughtspot.app/mcp`. +. Enter the SpotterCode MCP server URL. . Click **Add**. This configuration automatically enables SpotterCode in Claude AI chat and Claude Code for users of the Claude account. diff --git a/modules/ROOT/pages/spottercode.adoc b/modules/ROOT/pages/spottercode.adoc index 968b3150d..7cccf9568 100644 --- a/modules/ROOT/pages/spottercode.adoc +++ b/modules/ROOT/pages/spottercode.adoc @@ -13,7 +13,9 @@ SpotterCode connects your integrated development environment (IDE) to a ThoughtS [IMPORTANT] ==== -SpotterCode is an add-on tool available with the link:https://www.thoughtspot.com/pricing[ThoughtSpot Analytics and ThoughtSpot Embedded offerings, window=_blank]. If you have a ThoughtSpot Analytics license with an active ThoughtSpot Embedded subscription, you can integrate SpotterCode using the SpotterCode MCP Server URL in your coding application. +* SpotterCode is an add-on tool available with the link:https://www.thoughtspot.com/pricing[ThoughtSpot Analytics and ThoughtSpot Embedded offerings, window=_blank]. If you have a ThoughtSpot Analytics license with an active ThoughtSpot Embedded subscription, you can integrate SpotterCode using the SpotterCode MCP Server URL in your coding application. + +* When you connect an MCP client to the Spotter MCP server endpoint (`https://spottercode.thoughtspot.app/mcp`), you are prompted to authenticate with your ThoughtSpot instance. For unauthenticated documentation retrieval only, use the `/mcp/docs` endpoint. For more information, see xref:spottercode-integration.adoc#_authenticate_spottercode[Authenticate SpotterCode]. ==== == Who should use SpotterCode? @@ -43,12 +45,7 @@ The initial version of SpotterCode supports the following IDEs: * Claude Code == Supported skills -SpotterCode provides the following skills to the AI agent on your IDE: - -//// -* `get-visual-embed-sdk-reference` + -A documentation lookup skill that accesses Visual Embed SDK documentation and generates code samples for embedding ThoughtSpot content, including supported embed types, authentication, configuration, customization, event hooks, and code samples. -//// +SpotterCode provides the following skills to the AI agent in your IDE. Authenticated skills require a valid ThoughtSpot session established through the xref:spottercode-integration.adoc#_authenticate_spottercode[SpotterCode authentication flow]. * `get-rest-api-reference` + Provides REST API specifications, endpoints, request/response formats, authentication flows, CRUD operations, and SDKs for TypeScript and Java. @@ -56,6 +53,17 @@ Provides REST API specifications, endpoints, request/response formats, authentic * `get-developer-docs-reference` + Provides access to documentation on embedding, UI customization, deployment, security, and best practices. +* `run-ts-workflow` + +Executes authenticated ThoughtSpot API workflows directly from your IDE agent. Using the authenticated session established with your ThoughtSpot instance, this skill can perform common embed setup operations on your behalf, including: +** Generating a trusted authentication secret key +** Configuring CORS and CSP allowlists for your application domain +** Fetching Liveboard and Answer object IDs for use in embed code ++ +[NOTE] +==== +The `run-ts-workflow` skill requires a valid authenticated session with your ThoughtSpot instance. This skill is only available through the authenticated `/mcp` endpoint. It is not available through the unauthenticated `/mcp/docs` endpoint. +==== + == Limitations * Responses from SpotterCode are determined by the features and parameters currently supported in the Visual Embed SDK, REST API, and official ThoughtSpot Developer documentation. SpotterCode cannot generate code or solutions that rely on unsupported or undocumented features. diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index dc99edbb4..94c59c415 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -65,6 +65,16 @@ In full application embedding with the V3 navigation and home page experience, T --- +[discrete] +==== SpotterCode authentication and workflow execution +SpotterCode now supports authenticated sessions with your ThoughtSpot instance. When connecting your MCP client to the SpotterCode endpoint, you are prompted to log in using your organization's SAML identity provider. After authentication, SpotterCode can make ThoughtSpot API calls on your behalf. + +For programmatic use cases, SpotterCode also supports bearer token authentication. Developers who prefer unauthenticated documentation retrieval only can use the new `/mcp/docs` endpoint. + +For more information, see xref:spottercode-integration.adoc#_authenticate_spottercode[Authenticate SpotterCode] and xref:spottercode.adoc#_supported_skills[SpotterCode skills]. + +--- + [discrete] ==== Webhooks enhancements From 4a6ab756622ac24e32054edb79fae1882ac4af7b Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Wed, 22 Jul 2026 20:17:26 +0530 Subject: [PATCH 2/6] edits --- modules/ROOT/pages/whats-new.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index 94c59c415..c0aeacbe9 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -67,7 +67,7 @@ In full application embedding with the V3 navigation and home page experience, T [discrete] ==== SpotterCode authentication and workflow execution -SpotterCode now supports authenticated sessions with your ThoughtSpot instance. When connecting your MCP client to the SpotterCode endpoint, you are prompted to log in using your organization's SAML identity provider. After authentication, SpotterCode can make ThoughtSpot API calls on your behalf. +SpotterCode now supports authenticated sessions with your ThoughtSpot instance. When connecting your MCP client to the SpotterCode endpoint, you are prompted to log in using your organization's identity provider. After authentication, SpotterCode can make ThoughtSpot API calls on your behalf. For programmatic use cases, SpotterCode also supports bearer token authentication. Developers who prefer unauthenticated documentation retrieval only can use the new `/mcp/docs` endpoint. From a227095ea94423cceac592836e94bbe5fb10af44 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Thu, 23 Jul 2026 07:57:10 +0530 Subject: [PATCH 3/6] edits --- .../ROOT/pages/spottercode-integration.adoc | 117 +++++++++--------- modules/ROOT/pages/spottercode.adoc | 88 +++++++++---- modules/ROOT/pages/whats-new.adoc | 2 +- 3 files changed, 126 insertions(+), 81 deletions(-) diff --git a/modules/ROOT/pages/spottercode-integration.adoc b/modules/ROOT/pages/spottercode-integration.adoc index 232723a5e..5e5ab319a 100644 --- a/modules/ROOT/pages/spottercode-integration.adoc +++ b/modules/ROOT/pages/spottercode-integration.adoc @@ -61,49 +61,6 @@ SpotterCode extracts and validates the token and host, then injects the authenti To obtain a bearer token, use the xref:authentication.adoc[ThoughtSpot REST API v2 authentication endpoints] or trusted authentication. For more information, see xref:trusted-authentication.adoc[Trusted authentication]. ==== -=== MCP Server endpoint for documentation retrieval - -If you only need documentation and REST API reference retrieval, use the following MCP Server URL which unauthenticated endpoint: - ----- -`\https://spottercode.thoughtspot.app/mcp/docs` ----- - -This endpoint provides access to the `get-rest-api-reference` and `get-developer-docs-reference` skills only. The `run-ts-workflow` skill is not available through this endpoint. - -To use this endpoint in your IDE, replace the authenticated MCP server URL in your configuration: - -For Cursor (`mcp.json`):: -[source,JSON] ----- -{ - "mcpServers": { - "SpotterCode": { - "url": "https://spottercode.thoughtspot.app/mcp/docs" - } - } -} ----- - -For Claude Code (CLI):: -[source,Bash] ----- -claude mcp add --transport http SpotterCode https://spottercode.thoughtspot.app/mcp/docs ----- - -For Visual Studio Code (`mcp.json`):: -[source,JSON] ----- -{ - "servers": { - "SpotterCode": { - "url": "https://spottercode.thoughtspot.app/mcp/docs", - "type": "http" - } - } -} ----- - == Integrate SpotterCode with Cursor You can add the SpotterCode MCP Server URL to Cursor using the one-click installation link or the `mcp.json` file. @@ -114,7 +71,7 @@ Via Cursor Marketplace:: SpotterCode is available as an official plugin in the link:https://cursor.com/marketplace/thoughtspot[Cursor Marketplace, window=_blank]. To install SpotterCode from the Cursor Marketplace: . Go to link:https://cursor.com/marketplace/thoughtspot[Cursor Marketplace, window=_blank]. . Ensure that you are signed in, and then click **Add to Cursor** -> **Add Plugin**. -. To view the plugin in Cursor, click *View in Editor*. +. To view the plugin in Cursor, click **View in Editor**. Via installation link:: . Copy the following link and open it in Cursor: + @@ -147,10 +104,8 @@ Cursor also allows you to integrate SpotterCode by adding the MCP server URL in } } ---- -. Click *Save* and close the `mcp.json` file. This installs the SpotterCode MCP server and makes its tools available for AI models in Cursor. - - -For information about configuring MCP servers in Cursor, refer to the link:https://cursor.com/docs/context/mcp[Cursor Documentation, window=_blank]. +. Click **Save** and close the `mcp.json` file. +. In **Cursor Settings** > **Tools and MCP**, click **Connect**. You will be prompted to provide the URL of your ThoughtSpot instance and complete authentication. If the authentication is successful, the SpotterCode MCP server makes its tools available for AI models in Cursor. == Integrate SpotterCode with Claude @@ -165,8 +120,9 @@ To add SpotterCode as a custom connector: . Click the `+` icon and select **Add custom connector**. . Enter the SpotterCode MCP server URL. . Click **Add**. +. When prompted for authentication, specify the URL of your ThoughtSpot instance and complete authentication. -This configuration automatically enables SpotterCode in Claude AI chat and Claude Code for users of the Claude account. +//This configuration automatically enables SpotterCode in Claude AI chat and Claude Code for users of the Claude account. === Claude Code-only setup @@ -177,6 +133,8 @@ To enable SpotterCode in Claude Code, add the MCP server URL using the following claude mcp add --transport http SpotterCode https://spottercode.thoughtspot.app/mcp ---- +When prompted for authentication, specify the URL of your ThoughtSpot instance and complete authentication. + === Claude Desktop integration If you are using Claude Desktop, add the URL directly to the Claude configuration JSON file: @@ -191,17 +149,17 @@ If you are using Claude Desktop, add the URL directly to the Claude configuratio } ---- +When prompted for authentication, specify the URL of your ThoughtSpot instance and complete authentication. + === Claude Cowork integration If you are using Claude Cowork with Claude AI or Claude Desktop, verify whether the SpotterCode MCP connector is enabled for Claude Cowork. If it's not enabled, add the SpotterCode MCP server: -. Open Claude Cowork either in Claude AI or Claude Desktop app. +. Open Claude Cowork in either Claude AI or the Claude Desktop app. . Navigate to **Settings** > **Connectors** > **Customize**. . If SpotterCode is already available in your organization's list of connectors, select the SpotterCode connector. If it's not available: .. Click the `+` icon and select **Add custom connector**. .. Add the SpotterCode MCP server URL: `\https://spottercode.thoughtspot.app/mcp`. - -//For more information about adding MCP servers to Claude Code, see link:https://code.claude.com/docs/en/mcp[Claude Code Documentation, window=_blank]. - +. When prompted for authentication, specify the URL of your ThoughtSpot instance and complete authentication. == Integrate SpotterCode with Visual Studio Code @@ -221,7 +179,48 @@ To add the SpotterCode MCP Server to Visual Studio Code, use the Extensions view } ---- -After you add the MCP server URL, the SpotterCode MCP server is available in the Extensions view. For more information about configuring MCP servers in Visual Studio Code, refer to link:https://code.visualstudio.com/docs/copilot/customization/mcp-servers[Visual Studio Code Documentation, window=_blank]. +When prompted for authentication, specify the URL of your ThoughtSpot instance and complete authentication. + +After you add the MCP server URL, the SpotterCode MCP server is available in the Extensions view. + +=== Configuring MCP Server endpoint for documentation retrieval only + +If you only need documentation and REST API reference retrieval, use the following unauthenticated MCP Server URL: `\https://spottercode.thoughtspot.app/mcp/docs`. + +This endpoint provides access to the `get-rest-api-reference` and `get-developer-docs-reference` skills only. The `run-ts-workflow` skill is not available through this endpoint. + +To use this endpoint in your IDE, replace the authenticated MCP server URL in your configuration: + +For Cursor (`mcp.json`):: +[source,JSON] +---- +{ + "mcpServers": { + "SpotterCode": { + "url": "https://spottercode.thoughtspot.app/mcp/docs" + } + } +} +---- + +For Claude Code (CLI):: +[source,Bash] +---- +claude mcp add --transport http SpotterCode https://spottercode.thoughtspot.app/mcp/docs +---- + +For Visual Studio Code (`mcp.json`):: +[source,JSON] +---- +{ + "servers": { + "SpotterCode": { + "url": "https://spottercode.thoughtspot.app/mcp/docs", + "type": "http" + } + } +} +---- == Verify the integration @@ -232,6 +231,8 @@ To verify the integration: If the integration is successful, you'll see SpotterCode in the MCP servers list. . Verify the available SpotterCode skills. + +//// + For example, Cursor shows the skills of MCP connectors in the **Tools and MCP** page. Check if the xref:spottercode.adoc#_supported_skills[SpotterCode MCP skills] appear under SpotterCode. As you hover over each skill, you can view the description and input schema used for agentic interactions. You can also disable the MCP skills that you don't want the AI model to use. @@ -240,7 +241,7 @@ For example, Cursor shows the skills of MCP connectors in the **Tools and MCP** -- video::./images/cursor_mcp-skills.mp4[width=100%,options="autoplay,loop"] -- - +//// . Initiate a chat session and ask a question related to ThoughtSpot embedding, REST APIs, or the SDKs. + In the following example, a chat session with Cursor AI is initiated with the prompt, "I want to embed a ThoughtSpot Liveboard in my React application. Use the available tools to get this information and generate the embed code". Notice how the AI agent uses the SpotterCode skills to get the required information: @@ -273,13 +274,15 @@ video::./images/cursor-lb-embed.mp4[width=100%,options="autoplay,loop"] * For prompt examples, see xref:spottercode-prompt-guide.adoc#_prompt_examples[Prompt examples and best practices]. * For troubleshooting tips and workarounds, refer to the xref:spottercode-prompt-guide.adoc#_troubleshooting_errors[Troubleshooting] section. - +* For more information about adding MCP servers to Claude Code, see link:https://code.claude.com/docs/en/mcp[Claude Code Documentation, window=_blank]. +* For information about configuring MCP servers in Cursor, refer to the link:https://cursor.com/docs/context/mcp[Cursor Documentation, window=_blank]. +* For more information about configuring MCP servers in Visual Studio Code, refer to link:https://code.visualstudio.com/docs/copilot/customization/mcp-servers[Visual Studio Code Documentation, window=_blank]. //// . If your IDE shows the step-by-step explanation of how the Agent how the AI reached its conclusion, you may see the following parameters. These parameters show the input schema of the MCP request to SpotterCode. * `query` - User's request or question. For example, `how do I embed Liveboard`. * `version` - Version of the SDK to use. Default is `latest`. -* `topK` - How many relevant documents to return for the query. Default is 5. The agent may increase or decreased the number to get the right answer. +* `topK` - How many relevant documents to return for the query. Default is 5. The agent may increase or decrease the number to get the right answer. * `symbolName` - Limiting search to a specific item, for example, `LiveboardEmbed`. * `apiName` - The API node for finding request/response details. * `additionalDocs` - To include more documentation for extra context, such as Java or TypeScript SDK guidance. diff --git a/modules/ROOT/pages/spottercode.adoc b/modules/ROOT/pages/spottercode.adoc index 7cccf9568..1822f164a 100644 --- a/modules/ROOT/pages/spottercode.adoc +++ b/modules/ROOT/pages/spottercode.adoc @@ -6,43 +6,59 @@ :page-pageid: SpotterCode :page-description: Use SpotterCode to accelerate code generation and the process of embedding and integrating ThoughtSpot. -ThoughtSpot’s SpotterCode is an AI-powered MCP tool that streamlines and speeds up the process of embedding ThoughtSpot content and integrating ThoughtSpot REST APIs in your application workflows. +ThoughtSpot's SpotterCode is an AI-powered MCP tool that streamlines and speeds up the process of embedding ThoughtSpot content and integrating ThoughtSpot REST APIs in your application workflows. == What is SpotterCode? SpotterCode connects your integrated development environment (IDE) to a ThoughtSpot-hosted MCP server. It empowers AI-native IDEs with tools and documentation lookup capabilities, providing direct access to ThoughtSpot SDKs, REST API documentation, code samples, and developer guides. The AI agents in the IDE can use these skills to assist developers in embedding ThoughtSpot content and integrating REST API workflows into their applications. -[IMPORTANT] -==== -* SpotterCode is an add-on tool available with the link:https://www.thoughtspot.com/pricing[ThoughtSpot Analytics and ThoughtSpot Embedded offerings, window=_blank]. If you have a ThoughtSpot Analytics license with an active ThoughtSpot Embedded subscription, you can integrate SpotterCode using the SpotterCode MCP Server URL in your coding application. - -* When you connect an MCP client to the Spotter MCP server endpoint (`https://spottercode.thoughtspot.app/mcp`), you are prompted to authenticate with your ThoughtSpot instance. For unauthenticated documentation retrieval only, use the `/mcp/docs` endpoint. For more information, see xref:spottercode-integration.adoc#_authenticate_spottercode[Authenticate SpotterCode]. -==== - == Who should use SpotterCode? -SpotterCode is intended for developers and technical teams integrating ThoughtSpot content and workflows into their applications using Visual Embed SDK and REST APIs, with a particular focus on those working in AI-native IDEs such as Cursor. +SpotterCode is designed for developers and technical teams who embed ThoughtSpot content or integrate ThoughtSpot REST APIs into their applications using AI-native IDEs such as Cursor, Visual Studio Code with GitHub Copilot, or Claude Code. -When integrated, SpotterCode offers the following advantages: +When integrated, SpotterCode accelerates the process of embedding and integration by providing code samples, SDK skills, and custom styling directly in the IDE. It enables developers to build context-aware and deployment-ready code tailored to their project structure, thereby reducing manual effort and errors. -* Empowers your IDE with the documentation lookup and provides direct access to authoritative information on embedding ThoughtSpot or integrating REST API workflows in your development projects. +SpotterCode is useful at every stage of an embedded ThoughtSpot project: -* Accelerates the process of embedding and integration by providing code samples, SDK skills, and custom styling directly in the IDE. +* *Setting up a new embedded project* + +Use the authenticated `/mcp` endpoint so the IDE agent can configure your ThoughtSpot instance directly. You can generate a trusted authentication secret key, add your application domain to CORS and CSP allowlists, and retrieve Liveboard and Answer object IDs, all without leaving your IDE. -* Enables developers to build context-aware and deployment-ready code tailored to their project structure, thereby reducing manual effort and errors. +* *Writing and reviewing embed code* + +SpotterCode gives your IDE agent direct access to Visual Embed SDK and REST API documentation, code samples, and developer guides. The agent can generate context-aware embed code tailored to your project structure and provide direct access to the SDK reference. -* Reduces operational strain by rapidly generating boilerplate code required for embedding ThoughtSpot in your application. +* *Integrating REST API workflows* + +Access up-to-date REST API specifications, request and response formats, authentication flows, and TypeScript and Java SDK references to accelerate API integration. + +* *Looking up documentation* + +SpotterCode empowers your IDE with documentation lookup capabilities and provides direct access to authoritative information on embedding ThoughtSpot or integrating REST API workflows in your development projects. [NOTE] ==== SpotterCode is an acceleration tool designed to help developers streamline the process of integrating ThoughtSpot into their projects. It does not replace the Visual Embed SDK or the foundational knowledge required for embedding or application integration. ==== -== Supported IDEs - -The initial version of SpotterCode supports the following IDEs: - -* Cursor AI -* Visual Studio Code with GitHub Copilot -* Claude Code +[#_mcp_server_endpoints] +== MCP server endpoints +SpotterCode is an add-on tool available with the link:https://www.thoughtspot.com/pricing[ThoughtSpot Analytics and ThoughtSpot Embedded offerings, window=_blank]. If you have a ThoughtSpot Analytics license with an active ThoughtSpot Embedded subscription, you can integrate SpotterCode using the SpotterCode MCP Server URL in your coding application. + +ThoughtSpot provides the following MCP server endpoints for SpotterCode: + +[cols="1,2,2", options="header"] +|==== +| Endpoint | URL | Available skills +| *Authenticated endpoint* + +(`/mcp`) +| `\https://spottercode.thoughtspot.app/mcp` + +The full-capability SpotterCode endpoint. Requires authentication with a ThoughtSpot instance. Use this endpoint if you want your IDE agent to perform authenticated operations on your ThoughtSpot instance, such as generating secret keys, configuring CORS and CSP allowlists, and fetching Liveboard IDs. +| `get-rest-api-reference` + +`get-developer-docs-reference` + +`run-ts-workflow` + +| *Documentation endpoint* + +(`/mcp/docs`) +| `\https://spottercode.thoughtspot.app/mcp/docs` + +This endpoint includes documentation retrieval skills only and doesn't require authentication. Use this endpoint if you only need the AI agent to look up ThoughtSpot developer documentation and REST API reference, without connecting to a live ThoughtSpot instance. +| `get-rest-api-reference` + +`get-developer-docs-reference` +|==== == Supported skills SpotterCode provides the following skills to the AI agent in your IDE. Authenticated skills require a valid ThoughtSpot session established through the xref:spottercode-integration.adoc#_authenticate_spottercode[SpotterCode authentication flow]. @@ -61,12 +77,38 @@ Executes authenticated ThoughtSpot API workflows directly from your IDE agent. U + [NOTE] ==== -The `run-ts-workflow` skill requires a valid authenticated session with your ThoughtSpot instance. This skill is only available through the authenticated `/mcp` endpoint. It is not available through the unauthenticated `/mcp/docs` endpoint. +The `run-ts-workflow` skill requires a valid authenticated session with your ThoughtSpot instance. This skill is only available through the authenticated `/mcp` endpoint. ==== +=== Choosing the right endpoint +Use the following guidance to decide which endpoint to configure in your IDE: + +* *Use `/mcp` (authenticated)* if: +** You want the AI agent to execute ThoughtSpot API workflows from your IDE, for example, to generate a trusted authentication secret key, configure your application domain in CORS/CSP allowlists, or retrieve Liveboard and Answer object IDs from your instance. +** You want your IDE to use the full set of SpotterCode skills, including `run-ts-workflow`. +** You are building or configuring a ThoughtSpot embedded application and want end-to-end setup assistance without leaving the IDE. + +* *Use `/mcp/docs` (unauthenticated)* if: +** You only need the AI agent to look up documentation, REST API reference material, and code samples. +** You are working in an environment where connecting to a ThoughtSpot instance is not appropriate. For example, a shared CI environment, a read-only developer workstation, or a demonstration setup. +** You do not have a ThoughtSpot Embedded subscription or instance credentials available. + +[NOTE] +==== +The IDE configuration steps in this guide use the authenticated `/mcp` endpoint by default. If you want to use the unauthenticated `/mcp/docs` endpoint instead, replace the endpoint URL in the relevant configuration snippet before saving. All other configuration steps remain the same. +==== + +== Supported IDEs + +The initial version of SpotterCode supports the following IDEs: + +* Cursor AI +* Visual Studio Code with GitHub Copilot +* Claude Code + == Limitations -* Responses from SpotterCode are determined by the features and parameters currently supported in the Visual Embed SDK, REST API, and official ThoughtSpot Developer documentation. SpotterCode cannot generate code or solutions that rely on unsupported or undocumented features. +* Responses from SpotterCode are determined by the features and parameters currently supported in the Visual Embed SDK, REST API, and official ThoughtSpot developer documentation. SpotterCode cannot generate code or solutions that rely on unsupported or undocumented features. * SpotterCode can generate code samples for the most common use cases. Scenarios that require advanced customization or highly specialized workflows may require manual intervention or additional coding beyond what SpotterCode provides. * SpotterCode does not influence how the Spotter feature in your ThoughtSpot embed infers semantic modeling. SpotterCode is not intended for querying data models or interpreting definitions such as measures and attributes in your metadata objects. * The behavior of the IDE agent, including tool selection and reasoning, is not controlled by SpotterCode. diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index c0aeacbe9..5b5f9a2f8 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -96,7 +96,7 @@ The xref:webhooks-api.adoc#_updating_a_webhook[webhook update API endpoint] supp [discrete] ==== SpotterCode Agent in Visual Embed Playground [earlyAccess eaBackground]#Early Access# -The Visual Embed SDK Playground now includes SpotterCode Agent, an AI-powered coding assistant. The SpotterCode panel displays pre-built prompts relevant to the component you are embedding, a prompt interface for user queries, and generates embed code. It generates boilerplate code automatically, accelerates building code and iterating embed configurations. +The Visual Embed SDK Playground now includes SpotterCode Agent, an AI-powered coding assistant. The SpotterCode panel displays pre-built prompts relevant to the component you are embedding, provides a prompt interface for user queries, and generates embed code. It generates boilerplate code automatically, accelerates building code and iterating embed configurations. For more information, see xref:developer-playground.adoc#spottercode-panel[Using SpotterCode in the Playground]. From 98b9dcefbeb751e25fa0ccc1ddb803ff6bea5fb2 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Thu, 23 Jul 2026 11:44:30 +0530 Subject: [PATCH 4/6] review edits --- modules/ROOT/pages/spottercode-integration.adoc | 2 +- modules/ROOT/pages/spottercode.adoc | 16 ++++------------ modules/ROOT/pages/whats-new.adoc | 8 +++----- 3 files changed, 8 insertions(+), 18 deletions(-) diff --git a/modules/ROOT/pages/spottercode-integration.adoc b/modules/ROOT/pages/spottercode-integration.adoc index 5e5ab319a..805dc80b1 100644 --- a/modules/ROOT/pages/spottercode-integration.adoc +++ b/modules/ROOT/pages/spottercode-integration.adoc @@ -17,7 +17,7 @@ This guide walks you through the process of adding SpotterCode to your IDE. [#_authenticate_spottercode] == Authenticating to SpotterCode -The SpotterCode MCP Server at `https://spottercode.thoughtspot.app/mcp` requires authentication. Authentication enables SpotterCode to make API calls to your ThoughtSpot instance on your behalf, which is required to use the `run-ts-workflow` skill for tasks such as generating secret keys, configuring CORS and CSP allowlists, and fetching object IDs. +Starting with July 2026, the SpotterCode MCP Server at `https://spottercode.thoughtspot.app/mcp` requires authentication. Authentication enables SpotterCode to make API calls to your ThoughtSpot instance on your behalf, which is required to use the `run-ts-workflow` skill for tasks such as generating secret keys, configuring CORS and CSP allowlists, and fetching object IDs. SpotterCode supports two authentication mechanisms: diff --git a/modules/ROOT/pages/spottercode.adoc b/modules/ROOT/pages/spottercode.adoc index 1822f164a..495a5134f 100644 --- a/modules/ROOT/pages/spottercode.adoc +++ b/modules/ROOT/pages/spottercode.adoc @@ -47,10 +47,10 @@ ThoughtSpot provides the following MCP server endpoints for SpotterCode: | *Authenticated endpoint* + (`/mcp`) | `\https://spottercode.thoughtspot.app/mcp` + -The full-capability SpotterCode endpoint. Requires authentication with a ThoughtSpot instance. Use this endpoint if you want your IDE agent to perform authenticated operations on your ThoughtSpot instance, such as generating secret keys, configuring CORS and CSP allowlists, and fetching Liveboard IDs. +The full-capability SpotterCode endpoint. Requires authentication with a ThoughtSpot instance. You can use this MCP endpoint to perform authenticated user operations on your ThoughtSpot instance via the public REST APIs. | `get-rest-api-reference` + `get-developer-docs-reference` + -`run-ts-workflow` +`execute-thoughtspot-code` | *Documentation endpoint* + (`/mcp/docs`) @@ -69,16 +69,8 @@ Provides REST API specifications, endpoints, request/response formats, authentic * `get-developer-docs-reference` + Provides access to documentation on embedding, UI customization, deployment, security, and best practices. -* `run-ts-workflow` + -Executes authenticated ThoughtSpot API workflows directly from your IDE agent. Using the authenticated session established with your ThoughtSpot instance, this skill can perform common embed setup operations on your behalf, including: -** Generating a trusted authentication secret key -** Configuring CORS and CSP allowlists for your application domain -** Fetching Liveboard and Answer object IDs for use in embed code -+ -[NOTE] -==== -The `run-ts-workflow` skill requires a valid authenticated session with your ThoughtSpot instance. This skill is only available through the authenticated `/mcp` endpoint. -==== +* `execute-thoughtspot-code` + +Executes authenticated ThoughtSpot API workflows directly from your IDE agent. This skill allows your IDE agent to perform common operations that can be done via public REST APIs. === Choosing the right endpoint Use the following guidance to decide which endpoint to configure in your IDE: diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index 5b5f9a2f8..dcf1c05e0 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -66,12 +66,10 @@ In full application embedding with the V3 navigation and home page experience, T --- [discrete] -==== SpotterCode authentication and workflow execution -SpotterCode now supports authenticated sessions with your ThoughtSpot instance. When connecting your MCP client to the SpotterCode endpoint, you are prompted to log in using your organization's identity provider. After authentication, SpotterCode can make ThoughtSpot API calls on your behalf. +==== SpotterCode authentication and workflow execution [.version-badge.breaking]#Breaking# +SpotterCode now supports authenticated sessions with your ThoughtSpot instance. When connecting your MCP client to the SpotterCode endpoint, you are now prompted to log in using your organization's identity provider. After authentication, SpotterCode can make ThoughtSpot API calls on your behalf. -For programmatic use cases, SpotterCode also supports bearer token authentication. Developers who prefer unauthenticated documentation retrieval only can use the new `/mcp/docs` endpoint. - -For more information, see xref:spottercode-integration.adoc#_authenticate_spottercode[Authenticate SpotterCode] and xref:spottercode.adoc#_supported_skills[SpotterCode skills]. +For more information, see xref:spottercode.adoc#_mcp_server_endpoints[SpotterCode skills] and xref:spottercode-integration.adoc#_authenticate_spottercode[Authenticate SpotterCode]. --- From 62744c4f69fa96c506688c3a0fb112b28c600f49 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya <76986173+ShashiSubramanya@users.noreply.github.com> Date: Thu, 23 Jul 2026 14:51:49 +0530 Subject: [PATCH 5/6] Update whats-new.adoc --- modules/ROOT/pages/whats-new.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index dcf1c05e0..dea4f9121 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -26,7 +26,7 @@ This page lists new features, enhancements, and deprecated functionality introdu == July 2026 **Release version**: ThoughtSpot Cloud 26.7.0.cl + -*Upgrade notes*: No breaking changes + +*Upgrade notes*: Includes breaking changes to SpotterCode + *Recommended SDK versions*: Visual Embed SDK v1.50.0 and later [.cl-table, cols="2,4", frame=none, grid=none] @@ -658,4 +658,4 @@ For information about the new features and enhancements introduced in Visual Emb ==== REST API For information about REST API v2 enhancements, see xref:rest-apiv2-changelog.adoc[REST API v2.0 changelog]. -|=== \ No newline at end of file +|=== From 537b6465dd1f2cfd644eb40153a34def105851c1 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Fri, 24 Jul 2026 16:06:43 +0530 Subject: [PATCH 6/6] edits --- .../ROOT/pages/spottercode-integration.adoc | 4 ++-- modules/ROOT/pages/spottercode.adoc | 4 ++-- modules/ROOT/pages/whats-new.adoc | 19 ++++++++++--------- 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/modules/ROOT/pages/spottercode-integration.adoc b/modules/ROOT/pages/spottercode-integration.adoc index 805dc80b1..6abc417da 100644 --- a/modules/ROOT/pages/spottercode-integration.adoc +++ b/modules/ROOT/pages/spottercode-integration.adoc @@ -16,8 +16,8 @@ This guide walks you through the process of adding SpotterCode to your IDE. * Ensure that you have access to a ThoughtSpot instance and can view the objects and resources that you want to embed or access via the REST API. [#_authenticate_spottercode] -== Authenticating to SpotterCode -Starting with July 2026, the SpotterCode MCP Server at `https://spottercode.thoughtspot.app/mcp` requires authentication. Authentication enables SpotterCode to make API calls to your ThoughtSpot instance on your behalf, which is required to use the `run-ts-workflow` skill for tasks such as generating secret keys, configuring CORS and CSP allowlists, and fetching object IDs. +== Authentication +Starting with July 2026, the SpotterCode MCP Server endpoint requires you to authenticate with a ThoughtSpot instance. This allows SpotterCode to perform authenticated user operations using ThoughtSpot REST APIs. SpotterCode supports two authentication mechanisms: diff --git a/modules/ROOT/pages/spottercode.adoc b/modules/ROOT/pages/spottercode.adoc index 495a5134f..b6c3c133d 100644 --- a/modules/ROOT/pages/spottercode.adoc +++ b/modules/ROOT/pages/spottercode.adoc @@ -43,7 +43,7 @@ ThoughtSpot provides the following MCP server endpoints for SpotterCode: [cols="1,2,2", options="header"] |==== -| Endpoint | URL | Available skills +| Endpoint | URL | Available tools | *Authenticated endpoint* + (`/mcp`) | `\https://spottercode.thoughtspot.app/mcp` + @@ -60,7 +60,7 @@ This endpoint includes documentation retrieval skills only and doesn't require a `get-developer-docs-reference` |==== -== Supported skills +== Supported MCP tools SpotterCode provides the following skills to the AI agent in your IDE. Authenticated skills require a valid ThoughtSpot session established through the xref:spottercode-integration.adoc#_authenticate_spottercode[SpotterCode authentication flow]. * `get-rest-api-reference` + diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index dea4f9121..e81daa1b5 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -69,7 +69,16 @@ In full application embedding with the V3 navigation and home page experience, T ==== SpotterCode authentication and workflow execution [.version-badge.breaking]#Breaking# SpotterCode now supports authenticated sessions with your ThoughtSpot instance. When connecting your MCP client to the SpotterCode endpoint, you are now prompted to log in using your organization's identity provider. After authentication, SpotterCode can make ThoughtSpot API calls on your behalf. -For more information, see xref:spottercode.adoc#_mcp_server_endpoints[SpotterCode skills] and xref:spottercode-integration.adoc#_authenticate_spottercode[Authenticate SpotterCode]. +For more information, see the documentation on xref:spottercode.adoc#_mcp_server_endpoints[SpotterCode MCP Server] and xref:spottercode-integration.adoc#_authenticate_spottercode[Authenticating SpotterCode]. + +--- + +[discrete] +==== SpotterCode Agent in Visual Embed Playground [earlyAccess eaBackground]#Early Access# + +The Visual Embed SDK Playground now includes SpotterCode Agent, an AI-powered coding assistant. The SpotterCode panel displays pre-built prompts relevant to the component you are embedding, provides a prompt interface for user queries, and generates embed code. It generates boilerplate code automatically, accelerates building code and iterating embed configurations. + +For more information, see xref:developer-playground.adoc#spottercode-panel[Using SpotterCode in the Playground]. --- @@ -91,14 +100,6 @@ The xref:webhooks-api.adoc#_updating_a_webhook[webhook update API endpoint] supp --- -[discrete] -==== SpotterCode Agent in Visual Embed Playground [earlyAccess eaBackground]#Early Access# - -The Visual Embed SDK Playground now includes SpotterCode Agent, an AI-powered coding assistant. The SpotterCode panel displays pre-built prompts relevant to the component you are embedding, provides a prompt interface for user queries, and generates embed code. It generates boilerplate code automatically, accelerates building code and iterating embed configurations. - -For more information, see xref:developer-playground.adoc#spottercode-panel[Using SpotterCode in the Playground]. - ---- [discrete] ==== Org isolation for per-org SAML and OIDC authentication