Skip to content

Commit 44ea895

Browse files
committed
fix: define tools section to match template
1 parent 8ea6e93 commit 44ea895

File tree

1 file changed

+23
-60
lines changed

1 file changed

+23
-60
lines changed

docs/source/quickstart.mdx

Lines changed: 23 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -215,73 +215,36 @@ Alternatively, edit your Windsurf configuration file directly:
215215
1. Verify GraphQL operations are listed as available tools
216216
1. Test a query using one of your configured operations
217217

218-
## Configuration options
218+
## Step 4: Define MCP tools
219219

220-
When using Apollo MCP Server, you can customize the server configuration through your `config.yaml` file - see the [YAML Config Reference page](./config-file) for a list of options.
220+
MCP tools are defined as GraphQL operations. The project template currently uses operation collections as the source of its tools.
221221

222-
Examples:
222+
<Note>
223223

224-
<details>
225-
<summary>Basic Configuration</summary>
226-
227-
```yaml
228-
endpoint: https://your-graphql-endpoint.com/graphql
229-
operations:
230-
source: local
231-
paths:
232-
- ./operations
233-
schema:
234-
source: local
235-
path: ./schema.graphql
236-
transport:
237-
type: http
238-
port: 5050
239-
```
240-
</details>
241-
<details>
242-
<summary>Advanced Configuration</summary>
224+
See [Define MCP Tools](/apollo-mcp-server/define-tools) for other ways to define MCP tools.
243225

244-
```yaml
245-
endpoint: https://your-graphql-endpoint.com/graphql
246-
operations:
247-
source: local
248-
paths:
249-
- ./operations
250-
schema:
251-
source: local
252-
path: ./schema.graphql
253-
transport:
254-
type: http
255-
port: 5050
256-
host: localhost
257-
headers:
258-
Authorization: Bearer ${GRAPHQL_TOKEN}
259-
X-API-Key: ${API_KEY}
260-
timeout: 30000
261-
retry:
262-
attempts: 3
263-
delay: 1000
264-
```
226+
</Note>
265227

266-
</details>
228+
1. Navigate to Sandbox at [http://localhost:4000](http://localhost:4000).
229+
1. Click the Bookmark icon to open Operation Collections.
230+
1. Click **Sandbox** beside "Showing saved operations for your Sandbox, across all endpoints" and select your graph. This represents the graph name and ID you used when creating your project.
231+
1. You'll see an operation collection called "Default MCP Tools".
232+
1. Create a new operation in the middle panel:
267233

268-
<details>
269-
<summary>Environment Variables</summary>
270-
271-
You can use environment variables in your configuration:
272-
273-
```yaml
274-
endpoint: ${GRAPHQL_ENDPOINT}
275-
headers:
276-
Authorization: Bearer ${GRAPHQL_TOKEN}
277-
```
234+
```graphql
235+
# Retrieves product information
236+
query GetProducts {
237+
products {
238+
id
239+
name
240+
description
241+
}
242+
}
243+
```
278244

279-
Set these in your environment:
280-
```bash
281-
export GRAPHQL_ENDPOINT="https://your-api.com/graphql"
282-
export GRAPHQL_TOKEN="your-token-here"
283-
```
284-
</details>
245+
1. Click the **Save** button and give it the name `GetProducts`.
246+
1. Select the `Default MCP Tools` collection and click **Save**.
247+
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.
285248

286249
## Troubleshooting
287250

0 commit comments

Comments
 (0)