Skip to content

Commit 704d1c1

Browse files
committed
move troubleshooting down, add numbered steps
1 parent 277930e commit 704d1c1

File tree

1 file changed

+47
-50
lines changed

1 file changed

+47
-50
lines changed

docs/source/quickstart.mdx

Lines changed: 47 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -39,47 +39,45 @@ Type `Y` to confirm and create your project files.
3939

4040
You can start your MCP server locally with `rover dev`.
4141

42-
Choose the environment-specific command to load environment variables from the provided `.env` file and start the MCP server.
42+
1. Choose the environment-specific command to load environment variables from the provided `.env` file and start the MCP server.
4343

44-
<Tabs>
44+
<Tabs>
4545

46-
<Tab label="Linux / MacOS">
47-
48-
```terminal showLineNumbers=false
49-
set -a && source .env && set +a && rover dev --supergraph-config supergraph.yaml --mcp .apollo/mcp.local.yaml
50-
```
51-
52-
</Tab>
46+
<Tab label="Linux / MacOS">
47+
48+
```terminal showLineNumbers=false
49+
set -a && source .env && set +a && rover dev --supergraph-config supergraph.yaml --mcp .apollo/mcp.local.yaml
50+
```
5351

54-
<Tab label="Windows Powershell">
52+
</Tab>
5553

56-
```terminal showLineNumbers=false
57-
Get-Content .env | ForEach-Object { $name, $value = $_.split('=',2); [System.Environment]::SetEnvironmentVariable($name, $value) }
58-
rover dev --supergraph-config supergraph.yaml --mcp .apollo/mcp.local.yaml
59-
```
60-
</Tab>
61-
62-
</Tabs>
54+
<Tab label="Windows Powershell">
6355

64-
You should see some output indicating that the GraphQL server is running at `http://localhost:4000` and the MCP server is running at `http://127.0.0.1:5050`.
56+
```terminal showLineNumbers=false
57+
Get-Content .env | ForEach-Object { $name, $value = $_.split('=',2); [System.Environment]::SetEnvironmentVariable($name, $value) }
58+
rover dev --supergraph-config supergraph.yaml --mcp .apollo/mcp.local.yaml
59+
```
60+
</Tab>
61+
62+
</Tabs>
6563

66-
### Verify with MCP Inspector
64+
1. You should see some output indicating that the GraphQL server is running at `http://localhost:4000` and the MCP server is running at `http://127.0.0.1:5050`.
6765

68-
In a new terminal window, run the MCP Inspector:
66+
1. In a new terminal window, run the MCP Inspector to verify the server is running:
6967

70-
```terminal showLineNumbers=false
71-
npx @modelcontextprotocol/inspector http://127.0.0.1:5050/mcp --transport http
72-
```
68+
```terminal showLineNumbers=false
69+
npx @modelcontextprotocol/inspector http://127.0.0.1:5050/mcp --transport http
70+
```
7371

74-
This will automatically open your browser to `http://127.0.0.1:6274`.
72+
1. This will automatically open your browser to `http://127.0.0.1:6274`.
7573

76-
Click **Connect**, then **List Tools** to see the available tools.
74+
1. Click **Connect**, then **List Tools** to see the available tools.
7775

78-
## Step 3: Connect to Claude Desktop
76+
## Step 3: Connect to an MCP client
7977

8078
Apollo MCP Server works with any MCP-compatible client. Choose your favorite client and follow the instructions to connect.
8179

82-
<ExpansionPanel title="Claude Desktop">
80+
<ExpansionPanel title="Claude Desktop (recommended)">
8381

8482
Open the `claude_desktop_config.json` file in one of the following paths:
8583

@@ -210,10 +208,10 @@ Alternatively, edit your Windsurf configuration file directly:
210208
```
211209
</ExpansionPanel>
212210

213-
1. Restart your MCP client
214-
1. Test the connection by asking: "What MCP tools do you have available?"
215-
1. Verify GraphQL operations are listed as available tools
216-
1. Test a query using one of your configured operations
211+
1. Restart your MCP client.
212+
1. Test the connection by asking: "What MCP tools do you have available?".
213+
1. Verify GraphQL operations are listed as available tools.
214+
1. Test a query using one of your configured operations.
217215

218216
## Step 4: Define MCP tools
219217

@@ -246,27 +244,9 @@ See [Define MCP Tools](/apollo-mcp-server/define-tools) for other ways to define
246244
1. Select the `Default MCP Tools` collection and click **Save**.
247245
1. Restart your MCP client and test the connection by asking: "What MCP tools do you have available?". You should see the `GetProducts` tool listed. You can also test this with MCP Inspector.
248246

249-
## Troubleshooting
250-
251-
**Client doesn't see tools:**
252-
- Ensure you restarted your MCP client after configuration
253-
- Verify the Apollo MCP Server is running (`rover dev` command)
254-
- Check port numbers match between server and client config
255-
256-
**Connection refused errors:**
257-
- Confirm the server is running on the correct port
258-
- Verify firewall settings allow connections to localhost:5050
259-
- For remote connections, ensure the host is set to `0.0.0.0` in your config
260-
261-
262-
**Authentication issues:**
263-
- Verify environment variables are properly set
264-
- Check that your GraphQL endpoint accepts the provided headers
265-
- When using `rover dev` you can test your GraphQL endpoint using Sandbox at [http://localhost:4000](http://localhost:4000)
266-
267247
## Step 5: Deploy your MCP server
268248

269-
Once you're ready to deploy, Apollo MCP Server can run in any container environment.
249+
Apollo MCP Server can run in any container environment.
270250

271251
### Using the Apollo Runtime Container
272252

@@ -323,6 +303,23 @@ After deploying, update your MCP client configuration to use the deployed URL:
323303
}
324304
```
325305

306+
## Troubleshooting
307+
308+
**Client doesn't see tools:**
309+
- Ensure you restarted your MCP client after configuration
310+
- Verify the Apollo MCP Server is running (`rover dev` command)
311+
- Check port numbers match between server and client config
312+
313+
**Connection refused errors:**
314+
- Confirm the server is running on the correct port
315+
- Verify firewall settings allow connections to localhost:5050
316+
- For remote connections, ensure the host is set to `0.0.0.0` in your config
317+
318+
**Authentication issues:**
319+
- Verify environment variables are properly set
320+
- Check that your GraphQL endpoint accepts the provided headers
321+
- When using `rover dev` you can test your GraphQL endpoint using Sandbox at [http://localhost:4000](http://localhost:4000)
322+
326323
## Additional resources
327324

328325
- [Tutorial: Getting started with MCP and GraphQL](https://www.apollographql.com/tutorials/intro-mcp-graphql)

0 commit comments

Comments
 (0)