You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/spottercode-integration.adoc
+39-5Lines changed: 39 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
:toc: true
3
3
:toclevels: 2
4
4
5
-
:page-title: SpotterCode integration gude
5
+
:page-title: SpotterCode integration guide
6
6
:page-pageid: integrate-SpotterCode
7
7
:page-description: This document provides a comprehensive, step-by-step approach to integrating SpotterCode with your development environment
8
8
@@ -17,8 +17,30 @@ Connecting your IDE to ThoughtSpot's SpotterCode is easy. All you need is the Sp
17
17
18
18
== Integrate SpotterCode with Cursor
19
19
20
-
. To add the MCP server URL to your Cursor settings, go to **Cursor Settings** > **Tools and MCP**. Cursor opens the `mcp.json` file.
21
-
. Add the SpotterCode MCP Server URL as a remote MCP server. For information about configuring MCP servers in Cursor, refer to the link:https://cursor.com/docs/context/mcp[Cursor Documentation, window=_blank].
20
+
You can add the SpotterCode MCP Server URL to Cursor using the one-click installation link or the `mcp.json` file.
. On clicking this link, Cursor opens the MCP server installation page to add SpotterCode.
32
+
+
33
+
[.widthAuto]
34
+
image:./images/spottercode-cursor-url.png[SpotterCode MCP Server installation in Cursor]
35
+
36
+
. Click **Install**.
37
+
38
+
=== Using mcp.json file
39
+
40
+
Cursor also allows you to integrate SpotterCode by adding the MCP server URL in the `mcp.json` file. To add the URL:
41
+
42
+
. Go to **Cursor Settings** > **Tools and MCP**. Cursor opens the `mcp.json` file.
43
+
. Add the SpotterCode MCP Server URL as a remote MCP server.
22
44
+
23
45
[source,JSON]
24
46
----
@@ -32,6 +54,10 @@ Connecting your IDE to ThoughtSpot's SpotterCode is easy. All you need is the Sp
32
54
----
33
55
. Click *Save* and close the `mcp.json` file. This will install the SpotterCode MCP server and tools for the AI models on Cursor to execute.
34
56
57
+
58
+
For information about configuring MCP servers in Cursor, refer to the link:https://cursor.com/docs/context/mcp[Cursor Documentation, window=_blank].
59
+
60
+
35
61
== Integrate SpotterCode with Visual Studio Code
36
62
37
63
Although you can configure the MCP server in Visual Studio Code, to start a chat session with the AI agent, you'll need GitHub Copilot or a similar extension.
@@ -53,14 +79,22 @@ To add an MCP Server to Visual Studio Code, you can use the Extensions view, the
53
79
After you add the MCP server URL, the SpotterCode MCP server will be 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].
54
80
55
81
== Integrate SpotterCode with Claude Code
56
-
To enable SpotterCode in Claude Code, you can add the SpotterCode MCP server URL using the `claude mcp add` command via Claude CLI. If you are using Claude Desktop, you can add the URL directly to the Claude configuration JSON file:
82
+
83
+
To enable SpotterCode in Claude Code, add the MCP server URL using the following `claude mcp add` command in Claude Code CLI.
84
+
85
+
[source,Bash]
86
+
----
87
+
claude mcp add --transport http SpotterCode https://spottercode.thoughtspot.app/mcp
88
+
----
89
+
90
+
If you are using Claude Desktop, you can add the URL directly to the Claude configuration JSON file:
Copy file name to clipboardExpand all lines: modules/ROOT/pages/spottercode-prompt-guide.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,11 +86,11 @@ Generate a POST request to /api/rest/2.0/metadata/search, including required hea
86
86
How do I create a new user with admin privileges via REST API? Provide the endpoint, method, and sample payload.
87
87
|Get data from a chart via API| Generate a REST API request example to fetch data from a specific chart in a Liveboard.
88
88
|What do I need to include in my API request? | What headers are required for a REST API call to ThoughtSpot? List and explain each.
89
-
|How do I see new actions in my app? | How do get a list of custom actions added in my embed via REST API?
89
+
|How do I see new actions in my app? | How do I get a list of custom actions added in my embed via REST API?
90
90
|=====
91
91
92
92
== Troubleshooting errors
93
-
This section lists the common error scenarios, root causes, and recommended actions for troubleshooting errors related to SpotterCode integration. If the error persists, contact ThoughtSpot Support for further assistance.
93
+
This section lists the common error scenarios, root causes, and recommended actions for troubleshooting errors related to SpotterCode integration. If the error persists, contact ThoughtSpot Support for further assistance.
94
94
95
95
=== SpotterCode is not responding or failing to load
96
96
@@ -108,7 +108,7 @@ Recommended actions::
108
108
=== Unable to start a chat with SpotterCode
109
109
110
110
Possible causes::
111
-
- Development environment non-AI-native or not AI-enabled.
111
+
- The development environment is non-AI-native or not AI-enabled.
112
112
113
113
Recommended actions::
114
114
- If your IDE is not AI-native, try installing an extension, such as Copilot.
@@ -151,7 +151,7 @@ Recommended actions::
151
151
=== SDK client context mismatch
152
152
153
153
Possible causes::
154
-
SpotterCode couldn't determine the SDK content for your application or client.
154
+
SpotterCode couldn't determine the SDK context for your application or client.
155
155
156
156
Recommended actions::
157
157
Although the AI Agent on your IDE is capable of finding relevant information for your project context, we recommend stating the client environment and required SDK client library clearly in the prompt.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/spottercode.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,10 +56,10 @@ Provides access to documentation on embedding, UI customization, deployment, sec
56
56
57
57
== Limitations
58
58
59
-
- 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.
60
-
- 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.
61
-
- 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.
62
-
- The behavior of the IDE agent, including tool selection and reasoning, is not controlled by SpotterCode.
59
+
* 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.
60
+
* 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.
61
+
* 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.
62
+
* The behavior of the IDE agent, including tool selection and reasoning, is not controlled by SpotterCode.
0 commit comments