Skip to content

Commit 2f9d501

Browse files
prinkanintugleprinkanintugle
authored
Merge pull request #66 from Intugle/features/docs-mcp-instructions
Features/docs mcp instructions
2 parents b4e551f + 7256bb0 commit 2f9d501

5 files changed

Lines changed: 198 additions & 12 deletions

File tree

‎docsite/docs/mcp-server.md‎

Lines changed: 96 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,102 @@ With the server running, you can connect to it from any MCP-compatible client. T
3131

3232
Popular clients that support MCP include AI-powered IDEs and standalone applications. Here’s how to configure a few of them:
3333

34-
- **Cursor**: [Configuring MCP Servers](https://docs.cursor.com/en/context/mcp#configuring-mcp-servers)
35-
- **Claude Code**: [Using MCP with Claude Code](https://docs.claude.com/en/docs/claude-code/mcp)
36-
- **Claude Desktop**: [User Quickstart](https://modelcontextprotocol.info/docs/quickstart/user/)
37-
- **Gemini CLI**: [Configure MCP Servers](https://cloud.google.com/gemini/docs/codeassist/use-agentic-chat-pair-programmer#configure-mcp-servers)
34+
<details>
35+
<summary><b>Install in Cursor</b></summary>
36+
37+
Go to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`
38+
39+
Pasting the following configuration into your Cursor `~/.cursor/mcp.json` file is the recommended approach. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.
40+
41+
```json
42+
{
43+
"mcpServers": {
44+
"intugle": {
45+
"url": "http://localhost:8080/semantic_layer/mcp",
46+
"trust": true
47+
}
48+
}
49+
}
50+
```
51+
52+
</details>
53+
54+
<details>
55+
<summary><b>Install in VS Code</b></summary>
56+
57+
Add this to your VS Code `settings.json` file. See [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.
58+
59+
```json
60+
"mcp": {
61+
"servers": {
62+
"intugle": {
63+
"type": "http",
64+
"url": "http://localhost:8080/semantic_layer/mcp"
65+
}
66+
}
67+
}
68+
```
69+
70+
</details>
71+
72+
<details>
73+
<summary><b>Install in Gemini CLI</b></summary>
74+
75+
See [Gemini CLI Configuration](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html) for details.
76+
77+
1. Open the Gemini CLI settings file at `~/.gemini/settings.json`.
78+
2. Add the following to the `mcpServers` object in your `settings.json` file:
79+
80+
```json
81+
{
82+
"mcpServers": {
83+
"intugle": {
84+
"httpUrl": "http://localhost:8080/semantic_layer/mcp",
85+
"trust" : true
86+
}
87+
}
88+
}
89+
```
90+
91+
If the `mcpServers` object does not exist, create it.
92+
93+
</details>
94+
95+
<details>
96+
<summary><b>Install in JetBrains AI Assistant</b></summary>
97+
98+
See [JetBrains AI Assistant Documentation](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html) for more details.
99+
100+
1. In your JetBrains IDE, go to `Settings` -> `Tools` -> `AI Assistant` -> `Model Context Protocol (MCP)`.
101+
2. Click `+ Add`.
102+
3. Select `As JSON` from the list.
103+
4. Add this configuration and click `OK`:
104+
105+
```json
106+
{
107+
"mcpServers": {
108+
"intugle": {
109+
"type": "streamable-http",
110+
"url": "http://localhost:8080/semantic_layer/mcp"
111+
}
112+
}
113+
}
114+
```
115+
116+
5. Click `Apply` to save changes.
117+
118+
</details>
119+
120+
<details>
121+
<summary><b>Install in Claude Code</b></summary>
122+
123+
Run this command in your terminal. See [Claude Code MCP docs](https://docs.anthropic.com/en/docs/claude-code/mcp) for more info.
124+
125+
```sh
126+
claude mcp add --transport http intugle http://localhost:8080/semantic_layer/mcp
127+
```
128+
129+
</details>
38130

39131
## 2. Data Discovery Tools
40132

‎docsite/docs/vibe-coding.md‎

Lines changed: 96 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,102 @@ With the server running, you can connect to it from any MCP-compatible client. T
3535

3636
Popular clients that support MCP include AI-powered IDEs and standalone applications. Here’s how to configure a few of them:
3737

38-
- **Cursor**: [Configuring MCP Servers](https://docs.cursor.com/en/context/mcp#configuring-mcp-servers)
39-
- **Claude Code**: [Using MCP with Claude Code](https://docs.claude.com/en/docs/claude-code/mcp)
40-
- **Claude Desktop**: [User Quickstart](https://modelcontextprotocol.info/docs/quickstart/user/)
41-
- **Gemini CLI**: [Configure MCP Servers](https://cloud.google.com/gemini/docs/codeassist/use-agentic-chat-pair-programmer#configure-mcp-servers)
38+
<details>
39+
<summary><b>Install in Cursor</b></summary>
40+
41+
Go to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`
42+
43+
Pasting the following configuration into your Cursor `~/.cursor/mcp.json` file is the recommended approach. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.
44+
45+
```json
46+
{
47+
"mcpServers": {
48+
"intugle": {
49+
"url": "http://localhost:8080/semantic_layer/mcp",
50+
"trust": true
51+
}
52+
}
53+
}
54+
```
55+
56+
</details>
57+
58+
<details>
59+
<summary><b>Install in VS Code</b></summary>
60+
61+
Add this to your VS Code `settings.json` file. See [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.
62+
63+
```json
64+
"mcp": {
65+
"servers": {
66+
"intugle": {
67+
"type": "http",
68+
"url": "http://localhost:8080/semantic_layer/mcp"
69+
}
70+
}
71+
}
72+
```
73+
74+
</details>
75+
76+
<details>
77+
<summary><b>Install in Gemini CLI</b></summary>
78+
79+
See [Gemini CLI Configuration](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html) for details.
80+
81+
1. Open the Gemini CLI settings file at `~/.gemini/settings.json`.
82+
2. Add the following to the `mcpServers` object in your `settings.json` file:
83+
84+
```json
85+
{
86+
"mcpServers": {
87+
"intugle": {
88+
"httpUrl": "http://localhost:8080/semantic_layer/mcp",
89+
"trust" : true
90+
}
91+
}
92+
}
93+
```
94+
95+
If the `mcpServers` object does not exist, create it.
96+
97+
</details>
98+
99+
<details>
100+
<summary><b>Install in JetBrains AI Assistant</b></summary>
101+
102+
See [JetBrains AI Assistant Documentation](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html) for more details.
103+
104+
1. In your JetBrains IDE, go to `Settings` -> `Tools` -> `AI Assistant` -> `Model Context Protocol (MCP)`.
105+
2. Click `+ Add`.
106+
3. Select `As JSON` from the list.
107+
4. Add this configuration and click `OK`:
108+
109+
```json
110+
{
111+
"mcpServers": {
112+
"intugle": {
113+
"type": "streamable-http",
114+
"url": "http://localhost:8080/semantic_layer/mcp"
115+
}
116+
}
117+
}
118+
```
119+
120+
5. Click `Apply` to save changes.
121+
122+
</details>
123+
124+
<details>
125+
<summary><b>Install in Claude Code</b></summary>
126+
127+
Run this command in your terminal. See [Claude Code MCP docs](https://docs.anthropic.com/en/docs/claude-code/mcp) for more info.
128+
129+
```sh
130+
claude mcp add --transport http intugle http://localhost:8080/semantic_layer/mcp
131+
```
132+
133+
</details>
42134

43135
## 2. Vibe Coding
44136

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "intugle"
7-
version = "1.0.5"
7+
version = "1.0.6"
88
authors = [
99
{ name="Intugle", email="hello@intugle.ai" },
1010
]

‎src/intugle/mcp/docs_search/service.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ class DocsSearchService:
1010

1111
BASE_URL = "https://raw.githubusercontent.com/Intugle/data-tools/main/docsite/docs/"
1212
API_URL = "https://api.github.com/repos/Intugle/data-tools/contents/docsite/docs"
13+
BLACKLISTED_ROUTES = ["mcp-server.md", "vibe-coding.md"]
1314

1415
def __init__(self):
1516
self._doc_paths = None
@@ -39,8 +40,9 @@ async def _fetch_paths_recursively(self, session: aiohttp.ClientSession, url: st
3940

4041
for item in items:
4142
if item['type'] == 'file' and (item['name'].endswith('.md') or item['name'].endswith('.mdx')):
42-
# Strip the base 'docsite/docs/' part to make it a relative path
43-
paths.append(item['path'].replace('docsite/docs/', '', 1))
43+
relative_path = item['path'].replace('docsite/docs/', '', 1)
44+
if relative_path not in self.BLACKLISTED_ROUTES:
45+
paths.append(relative_path)
4446
elif item['type'] == 'dir':
4547
paths.extend(await self._fetch_paths_recursively(session, item['url']))
4648
except Exception as e:

‎uv.lock‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)