Skip to content

Commit c30199f

Browse files
Refactor README installation instructions for MCP; streamline automatic and manual setup processes, and remove outdated sections for clarity.
1 parent 433fd30 commit c30199f

File tree

1 file changed

+8
-59
lines changed

1 file changed

+8
-59
lines changed

README.md

Lines changed: 8 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -18,49 +18,23 @@ Have you ever spent hours looking for how to configure a SparkMax motor controll
1818

1919
## Installation for VS Code
2020

21-
### Method 1: Automatic Installation (Recommended)
22-
23-
The easiest way to install - VS Code will automatically configure everything for you:
24-
25-
1. Open VS Code
26-
2. Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac) to open the command palette
27-
3. Type "MCP: Add Server" and select it
28-
4. Choose "Pip package" from the options
29-
5. When prompted, enter: `first-agentic-csa`
30-
6. VS Code will automatically install and configure everything for you!
31-
32-
**Note:** Some users may encounter a "model_not_supported" error with this method. If that happens, use Method 2 (Manual Configuration) below - it's a reliable fallback that avoids this issue entirely.
33-
34-
### Method 2: Manual Configuration (Fallback if automatic installation fails)
35-
36-
If you encounter any issues with automatic installation, you can configure the server manually. This method avoids potential AI model compatibility issues and works consistently across all VS Code versions.
37-
38-
**Quick Setup:**
39-
1. Open VS Code Settings (File → Preferences → Settings, or `Ctrl+,`)
40-
2. Click the "Open Settings (JSON)" icon in the top right, or press `Ctrl+Shift+P` and type "Preferences: Open User Settings (JSON)"
41-
3. Copy the configuration from `vscode-settings.example.json` in this repository, or add this to your `settings.json`:
21+
1. Install `uv` if you haven't already. You can install it via:
22+
- **Windows/Mac/Linux**: `pip install uv` or visit [https://github.com/astral-sh/uv](https://github.com/astral-sh/uv)
23+
2. Open VS Code
24+
3. Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac) to open the command palette
25+
4. Type "MCP: Add User Configuration" and select it
26+
5. In the server settings, paste this configuration:
4227

4328
```json
44-
{
45-
"mcp.servers": {
4629
"frc-docs": {
4730
"command": "uvx",
4831
"args": ["first-agentic-csa"]
4932
}
5033
}
51-
}
5234
```
5335

54-
**Note:** If `mcp.servers` doesn't work, try `mcpServers` (camelCase) instead. The exact key name depends on your VS Code version.
55-
56-
4. Save the file and restart VS Code
57-
5. The MCP server should now be available!
58-
59-
**Alternative: Via VS Code Settings UI**
60-
- Open VS Code Settings (`Ctrl+,`)
61-
- Search for "MCP" in the settings search bar
62-
- Look for "MCP: Servers" setting
63-
- Click "Edit in settings.json" and add the configuration above
36+
6. Save the file and restart VS Code
37+
7. The MCP server should now be available!
6438

6539
### Setting Up GitHub Copilot
6640

@@ -92,22 +66,6 @@ This tool searches through documentation from:
9266

9367
You can search all of them at once, or pick specific ones to search.
9468

95-
## Installation for Others
96-
97-
To install this mcp in other editors that do not have the user interface for the pip package you can add the following to your mcp config json file:
98-
99-
```json
100-
{
101-
"mcpServers": {
102-
"frc-docs": {
103-
"command": "uvx",
104-
"args": ["first-agentic-csa"],
105-
}
106-
}
107-
}
108-
```
109-
110-
You will then have to add the instructions to your prompts manually or to your tools rules.
11169

11270
## Customization (Optional)
11371

@@ -122,15 +80,6 @@ Most teams don't need to change anything - the defaults work well!
12280

12381
## Troubleshooting
12482

125-
### "The requested model is not supported" error
126-
127-
If you see this error when trying to add the server:
128-
```
129-
Failed to generate MCP configuration for first-agentic-csa: Request Failed: 400 {"error":{"message":"The requested model is not supported."...}}
130-
```
131-
132-
This happens when VS Code tries to use AI to generate the configuration, but the AI model isn't supported. **Solution:** Use Method 2 (Manual Configuration) from the Installation section above. Manual configuration bypasses this issue entirely and is a reliable fallback.
133-
13483
### "Command not found" or Server won't start
13584

13685
Make sure you:

0 commit comments

Comments
 (0)