Skip to content

Commit 03120df

Browse files
oatsandsugaroatsandsugar
authored
docs: vs-code aurora docs- completes PM-139, PM-141, PM-143, PM-23 (#2505)
* docs: add vs-code aurora docs * docs: add release note for VS Code [PM-139] * docs: release notes: explain removal of read files tool [PM-23]
1 parent 327e712 commit 03120df

File tree

8 files changed

+8422
-10089
lines changed

8 files changed

+8422
-10089
lines changed

‎apps/framework-docs/src/pages/aurora/getting-started/_meta.tsx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ const meta = {
44
claude: "Claude Desktop",
55
cursor: "Cursor",
66
windsurf: "Windsurf",
7+
"vs-code": "VS Code",
78
"other-clients": "Other Clients",
89
};
910

‎apps/framework-docs/src/pages/aurora/getting-started/claude.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,4 @@ For more information on available toolsets, see [Aurora MCP toolsets](/aurora/re
123123
variant="aurora"
124124
/>
125125

126-
</FeatureGrid>
126+
</FeatureGrid>

‎apps/framework-docs/src/pages/aurora/getting-started/cursor.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ bash -i <(curl -fsSL https://fiveonefour.com/install.sh) aurora,moose
3939

4040
<Tabs items={['Aurora CLI', 'MCP.json']}>
4141
<Tabs.Tab>
42-
Create a new project with Claude Desktop MCP preconfigured:
42+
Create a new project with Cursor MCP preconfigured:
4343

4444
```bash filename="Terminal" copy
4545
aurora init <project-name> <template-name> --mcp cursor-project

‎apps/framework-docs/src/pages/aurora/getting-started/other-clients.mdx‎

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Getting started guide for Aurora
44
---
55

66
import { Callout } from "@/components";
7-
import { Steps } from "nextra/components";
7+
import { Steps, Tabs } from "nextra/components";
88
import {
99
CTACard,
1010
CTACards,
@@ -31,7 +31,17 @@ To try set up your client with Aurora MCP, use the MCP.JSON file within your cli
3131

3232
### Configure Aurora MCP
3333

34-
```json filename="~/Library/Application Support/Claude/claude_desktop_config.json" copy
34+
<Callout type="warning">
35+
**Configuration Object Naming**: Different MCP clients use different naming conventions for the server configuration object:
36+
- **Cursor, Windsurf**: Uses `"mcpServers"`
37+
- **Claude Desktop, VS Code**: Use `"servers"` instead
38+
39+
Make sure to check your specific client's documentation for the correct naming convention.
40+
</Callout>
41+
42+
<Tabs items={['Cursor, Windsurf', 'Claude Desktop, VS Code']}>
43+
<Tabs.Tab>
44+
```json filename="MCP configuration" copy
3545
{
3646
"mcpServers": {
3747
"aurora": {
@@ -51,6 +61,30 @@ To try set up your client with Aurora MCP, use the MCP.JSON file within your cli
5161
}
5262
}
5363
```
64+
</Tabs.Tab>
65+
<Tabs.Tab>
66+
```json filename="MCP configuration" copy
67+
{
68+
"servers": {
69+
"aurora": {
70+
"args": [
71+
"@514labs/aurora-mcp@latest",
72+
"--moose-read-tools",
73+
"path/to/your/moose/project"
74+
],
75+
"command": "npx",
76+
"env": {
77+
"ANTHROPIC_API_KEY": "<your-anthropic-api-key>",
78+
"MOOSE_PATH": "path/to/your/moose/installation",
79+
"NODE_PATH": "path/to/your/node/installation",
80+
"PYTHON_PATH": "path/to/your/python/installation"
81+
}
82+
}
83+
}
84+
}
85+
```
86+
</Tabs.Tab>
87+
</Tabs>
5488

5589
### Adding other toolsets
5690

‎apps/framework-docs/src/pages/aurora/getting-started/vs-code.mdx‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: Getting Started
3+
description: Getting started guide for Aurora
4+
---
5+
6+
import { Callout } from "@/components";
7+
import { Tabs, Steps, Card, FileTree } from "nextra/components";
8+
import {
9+
CTACard,
10+
CTACards,
11+
ZoomImg,
12+
ChipButton,
13+
Columns,
14+
Column,
15+
FeatureCard,
16+
FeatureGrid,
17+
BulletPointsCard,
18+
QnABullets,
19+
CheckmarkBullets,
20+
Icons,
21+
} from "@/components";
22+
import { ArgTable } from "@/components/ArgTable";
23+
24+
25+
## VS Code
26+
27+
<Steps>
28+
29+
<Callout type="info" title="Additional requirements">
30+
- **VS Code**: [Install VS Code here](https://code.visualstudio.com/).
31+
- **GitHub Copilot in VS Code**: [See VS Code docs](https://code.visualstudio.com/docs/copilot/setup)
32+
</Callout>
33+
34+
### Install VS Code and enable MCPs
35+
[Install VS Code here](https://code.visualstudio.com/).
36+
37+
[Enable MCPs](vscode://settings/chat.mcp.enabled) by toggling on the `chat.mcp.enabled` setting.
38+
39+
### Install Moose and Aurora CLI
40+
41+
```bash filename="Terminal" copy
42+
bash -i <(curl -fsSL https://fiveonefour.com/install.sh) aurora,moose
43+
```
44+
45+
### Configure Aurora MCP
46+
47+
<Tabs items={['Aurora CLI', 'MCP.json (settings.json)']}>
48+
<Tabs.Tab>
49+
Create a new project with Claude Desktop MCP preconfigured:
50+
51+
```bash filename="Terminal" copy
52+
aurora init <project-name> <template-name> --mcp vscode-project
53+
```
54+
55+
If you want to use this as a global VS Code MCP, use `vscode-global` instead of `vscode-project`.
56+
57+
For other options, see [Aurora CLI docs](/aurora/getting-started/aurora-cli).
58+
</Tabs.Tab>
59+
<Tabs.Tab>
60+
```json filename="/path/to/your/project/.cursor/settings.json" copy
61+
{
62+
"mcp": {
63+
"input": [],
64+
"servers": {
65+
"aurora": {
66+
"args": [
67+
"@514labs/aurora-mcp@latest",
68+
"--moose-read-tools",
69+
"path/to/your/moose/project"
70+
],
71+
"command": "npx",
72+
"env": {
73+
"ANTHROPIC_API_KEY": "<your-anthropic-api-key>",
74+
"MOOSE_PATH": "path/to/your/moose/installation",
75+
"NODE_PATH": "path/to/your/node/installation",
76+
"PYTHON_PATH": "path/to/your/python/installation"
77+
}
78+
}
79+
}
80+
}
81+
}
82+
```
83+
</Tabs.Tab>
84+
</Tabs>
85+
86+
### Adding other toolsets
87+
88+
For more information on available toolsets, see [Aurora MCP toolsets](/aurora/reference/tool-reference). All toolsets are available for Cursor.
89+
90+
### Using the MCP
91+
92+
[ ] TODO: Add instructions for running the MCP server in VS Code
93+
94+
</Steps>
95+
96+
### Warnings / Peculiarities
97+
98+
<Callout type="warning">
99+
**Recommended Configuration Method**: While VS Code has a feature that allows you to use MCPs from other clients (like Claude Desktop), we strongly recommend using either the **Aurora CLI** or the **settings.json file** method shown above instead. These methods provide better reliability and configuration control specifically for VS Code environments.
100+
</Callout>
101+
102+
### Common issues / troubleshooting
103+
104+
* The MCP is running, but you aren't able to get your data? Look at the tool call response, it will tell you if your Moose dev server is running. If it is not, run `moose dev` in your Moose project directory.
105+
* The MCP is not running. Check your configuration and then restart the application.
106+
107+
## Reference
108+
<FeatureGrid columns={3}>
109+
110+
<FeatureCard
111+
href="/aurora/reference/cli-reference"
112+
title="CLI reference"
113+
description="
114+
"
115+
variant="aurora"
116+
/>
117+
118+
<FeatureCard
119+
href="/aurora/reference/mcp-json-reference"
120+
title="MCP.json reference"
121+
description="
122+
"
123+
variant="aurora"
124+
/>
125+
126+
<FeatureCard
127+
href="/aurora/reference/tool-reference"
128+
title="Tools reference"
129+
description="
130+
"
131+
variant="aurora"
132+
/>
133+
134+
</FeatureGrid>

‎apps/framework-docs/src/pages/aurora/reference/mcp-json-reference.mdx‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,23 @@ For other clients, look to their documentation for where their MCP.JSON file is
4242

4343
### Adding Aurora MCP to your MCP.JSON file
4444

45-
Your MCP.JSON contains an mcpServers object, which is an array of MCP servers. To add Aurora MCP to your MCP.JSON file, you need to add the following to the mcpServers array:
45+
<Callout type="warning">
46+
**Configuration Object Naming**: Different MCP clients use different naming conventions for the server configuration object:
47+
- **Cursor, Windsurf**: Uses `"mcpServers"`
48+
- **Claude Desktop, VS Code**: Use `"servers"` instead
4649

47-
```json filename="MCP.JSON" copy
50+
Make sure to check your specific client's documentation for the correct naming convention.
51+
</Callout>
52+
53+
<Tabs items={['Cursor, Windsurf', 'Claude Desktop, VS Code']}>
54+
<Tabs.Tab>
55+
```json filename="MCP configuration" copy
4856
{
4957
"mcpServers": {
5058
"aurora": {
5159
"args": [
5260
"@514labs/aurora-mcp@latest",
5361
"--moose-read-tools",
54-
"--moose-write-tools"
55-
...other tool-sets,
5662
"path/to/your/moose/project"
5763
],
5864
"command": "npx",
@@ -66,6 +72,30 @@ Your MCP.JSON contains an mcpServers object, which is an array of MCP servers. T
6672
}
6773
}
6874
```
75+
</Tabs.Tab>
76+
<Tabs.Tab>
77+
```json filename="MCP configuration" copy
78+
{
79+
"servers": {
80+
"aurora": {
81+
"args": [
82+
"@514labs/aurora-mcp@latest",
83+
"--moose-read-tools",
84+
"path/to/your/moose/project"
85+
],
86+
"command": "npx",
87+
"env": {
88+
"ANTHROPIC_API_KEY": "<your-anthropic-api-key>",
89+
"MOOSE_PATH": "path/to/your/moose/installation",
90+
"NODE_PATH": "path/to/your/node/installation",
91+
"PYTHON_PATH": "path/to/your/python/installation"
92+
}
93+
}
94+
}
95+
}
96+
```
97+
</Tabs.Tab>
98+
</Tabs>
6999

70100
### Arguments / Environment Variables
71101

‎apps/framework-docs/src/pages/release-notes/index.mdx‎

Lines changed: 46 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,30 @@ As always, to get the latest:
1212
bash -i <(curl -fsSL https://fiveonefour.com/install.sh) moose,aurora
1313
```
1414

15-
## Friday, 30th May 2025
15+
## Wednesday, 3 July 2025
16+
17+
<Callout type="info" title="Highlights">
18+
* **Aurora users** can now use Aurora MCP with VS Code, bringing CLI based MCP configuration to VS Code, Cursor, Windsurf and Claude Desktop.
19+
</Callout>
20+
21+
### Aurora
22+
23+
#### VS Code Support
24+
25+
If you want to add Aurora MCP to your existing Moose project in VS Code, try
26+
```bash filename="Terminal" copy
27+
aurora setup --mcp vscode-project
28+
```
29+
30+
See the [VS Code setup guide](/aurora/getting-started/vs-code) for more details.
31+
32+
#### Removal of `read_file` tool
33+
We originally created the `read_file` tool to allow non-code-editor clients to write and read files. From our work with users, we have seen that when people are creating and editing code, they are using code editors, and they primarily use chat based clients for consumption.
34+
35+
#### Changing standard tools for each client
36+
Accordingly, Claude-Desktop now defaults to read tools, and code editors now default to read and write tools.
37+
38+
## Friday, 30 May 2025
1639

1740

1841
<Callout type="info" title="Highlights">
@@ -39,25 +62,25 @@ https://explorer:@play.clickhouse.com:443/?database=default
3962

4063

4164
<ToggleBlock openText="Need help finding credentials?" closeText="Hide credential help">
42-
<Tabs items={["ClickHouse Cloud", "Self-Hosted", "Docker"]}>
43-
<Tabs.Tab>
44-
1. Log into your [ClickHouse Cloud console](https://clickhouse.cloud/)
45-
2. Go to your service details page
46-
3. Find "Connect" or "Connection Details" section
47-
4. Copy the HTTPS endpoint and your username/password
48-
</Tabs.Tab>
49-
<Tabs.Tab>
50-
- Check your ClickHouse config file (usually `/etc/clickhouse-server/config.xml`)
51-
- Look for `<http_port>` (default: 8123) and `<https_port>` (default: 8443)
52-
- Check users config in `/etc/clickhouse-server/users.xml` or users.d/ directory
53-
- Default user is often `default` with no password
54-
</Tabs.Tab>
55-
<Tabs.Tab>
56-
- Check your docker-compose.yml or docker run command for environment variables
57-
- Look for `CLICKHOUSE_USER`, `CLICKHOUSE_PASSWORD`, `CLICKHOUSE_DB`
58-
- Default is usually `http://default:@localhost:8123/?database=default`
59-
</Tabs.Tab>
60-
</Tabs>
65+
<Tabs items={["ClickHouse Cloud", "Self-Hosted", "Docker"]}>
66+
<Tabs.Tab>
67+
1. Log into your [ClickHouse Cloud console](https://clickhouse.cloud/)
68+
2. Go to your service details page
69+
3. Find "Connect" or "Connection Details" section
70+
4. Copy the HTTPS endpoint and your username/password
71+
</Tabs.Tab>
72+
<Tabs.Tab>
73+
- Check your ClickHouse config file (usually `/etc/clickhouse-server/config.xml`)
74+
- Look for `<http_port>` (default: 8123) and `<https_port>` (default: 8443)
75+
- Check users config in `/etc/clickhouse-server/users.xml` or users.d/ directory
76+
- Default user is often `default` with no password
77+
</Tabs.Tab>
78+
<Tabs.Tab>
79+
- Check your docker-compose.yml or docker run command for environment variables
80+
- Look for `CLICKHOUSE_USER`, `CLICKHOUSE_PASSWORD`, `CLICKHOUSE_DB`
81+
- Default is usually `http://default:@localhost:8123/?database=default`
82+
</Tabs.Tab>
83+
</Tabs>
6184
</ToggleBlock>
6285

6386
<ToggleBlock openText="Common Issues" closeText="Hide Common Issues">
@@ -71,10 +94,7 @@ https://explorer:@play.clickhouse.com:443/?database=default
7194

7295
</ToggleBlock>
7396

74-
75-
76-
77-
## Friday, 23rd May 2025
97+
## Friday, 23 May 2025
7898

7999
<Callout type="info" title="Highlights">
80100
* **Moose users** can now handle stream processing failures with **Dead Letter Queues** — comprehensive error handling with type-safe recovery workflows in both TypeScript and Python.
@@ -199,7 +219,7 @@ This means you can eliminate downtime from bad data, debug failures faster with
199219

200220
See [Dead Letter Queues documentation](../building/dead-letter-queues) for complete setup and recovery patterns.
201221

202-
## Monday, 19th May 2025
222+
## Monday, 19 May 2025
203223

204224
<Callout type="info" title="Highlights">
205225
* **Moose and Aurora users** can now embed metadata into their Moose primitives, for use by users, their agents, and their metadata tools.
@@ -235,7 +255,7 @@ const acPipeline = new IngestPipeline<AircraftTrackingProcessed>(
235255
* To be on a field level as well as a primitive level
236256
* To include any arbitrary key value pair, not just a description (use this for managing labels like PII!)
237257

238-
## Friday, 16th May 2025
258+
## Friday, 16 May 2025
239259

240260
<Callout type="info" title="Highlights">
241261
* **Aurora users** can now leverage **DuckDB** for local data wrangling.

0 commit comments

Comments
 (0)