Skip to content

Commit 93e607b

Browse files
committed
chore: update space devs readme
1 parent 373b34d commit 93e607b

File tree

2 files changed

+16
-93
lines changed

2 files changed

+16
-93
lines changed
File renamed without changes.

graphql/TheSpaceDevs/README.md

Lines changed: 16 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -38,28 +38,22 @@ Here is an example configuration you can use _(Note: you must provide your fill
3838
"thespacedevs": {
3939
"command": "/Users/michaelwatson/Documents/GitHub/apollographql/apollo-mcp-server/target/debug/apollo-mcp-server",
4040
"args": [
41-
"--directory",
42-
"/Users/michaelwatson/Documents/GitHub/apollographql/apollo-mcp-server/graphql/TheSpaceDevs",
43-
"--schema",
44-
"api.graphql",
45-
"--operations",
46-
"operations",
47-
"--endpoint",
48-
"https://thespacedevs-production.up.railway.app/",
49-
"--introspection"
41+
"graphql/TheSpaceDevs/config.yaml"
5042
]
5143
}
5244
}
5345
}
5446
```
5547

56-
## Using Server-Side-Events (SSE) with Apollo MCP server
48+
## Using Streamable HTTP with Apollo MCP server
5749

58-
There are operations located at `./operations/*.graphql` for you to use in your configuration. You can provide a set of operations in your MCP configuration along with the `--introspection` option that enables the LLM to generate a dynamic operation along with the ability to execute it.
50+
There are operations located at `./operations/*.graphql` for you to use in your configuration. You can provide a set of operations in your MCP configuration that enables the LLM to generate a dynamic operation along with the ability to execute it.
5951

60-
### Running SSE with `rover dev`
52+
### Running with `rover dev`
6153

62-
**_Coming soon_**
54+
```BASH
55+
rover dev --supergraph-config supergraph.yaml --mcp config.yaml
56+
```
6357

6458
### Running Apollo MCP server Docker image
6559

@@ -70,24 +64,24 @@ docker run \
7064
-it --rm \
7165
--name apollo-mcp-server \
7266
-p 8000:8000 \
67+
-v $PWD/graphql/TheSpaceDevs/config.yaml \
7368
-v $PWD/graphql/TheSpaceDevs:/data \
74-
ghcr.io/apollographql/apollo-mcp-server:latest \
75-
--http-port 8000 \
76-
--schema api.graphql \
77-
--operations operations \
78-
--endpoint https://thespacedevs-production.up.railway.app/
69+
ghcr.io/apollographql/apollo-mcp-server:latest /config.yaml
7970
```
8071

81-
2. Add the MCP SSE port to your MCP Server configuration for the client appliction you are running. If you are running locally, the server link will be `http://127.0.0.1:8000/sse`.
72+
2. Add the MCP port to your MCP Server configuration for the client application you are running. If you are running locally, the server link will be `http://127.0.0.1:8000/mcp`.
8273

8374
_Note: Claude Desktop currently doesn't support SSE_
8475

8576
```
8677
{
8778
"mcpServers": {
8879
"thespacedevs": {
89-
"type": "sse",
90-
"url": "http://127.0.0.1:8000/sse>"
80+
"command": "npx",
81+
"args": [
82+
"mcp-remote",
83+
"http://127.0.0.1:8000/mcp"
84+
]
9185
}
9286
}
9387
}
@@ -103,80 +97,9 @@ Here is an example configuration you can use _(Note: you must provide your fill
10397
"thespacedevs": {
10498
"command": "/Users/michaelwatson/Documents/GitHub/apollographql/apollo-mcp-server/target/debug/apollo-mcp-server",
10599
"args": [
106-
"--directory",
107-
"/Users/michaelwatson/Documents/GitHub/apollographql/apollo-mcp-server/graphql/TheSpaceDevs",
108-
"--schema",
109-
"api.graphql",
110-
"--operations",
111-
"operations",
112-
"--endpoint",
113-
"https://thespacedevs-production.up.railway.app/",
114-
"--introspection"
100+
"graphql/TheSpaceDevs/config.yaml"
115101
]
116102
}
117103
}
118104
}
119105
```
120-
121-
## Using Persisted Queries - GraphOS Scale and Enterprise tiers only
122-
123-
You can configure the Apollo MCP server to use [Persisted Queries with GraphOS](https://www.apollographql.com/docs/graphos/routing/security/persisted-queries). In order to do this, you'll have to setup GraphOS and run a router instance configured to that persisted query list:
124-
125-
1. Create a new graph in [GraphOS](https://studio.apollographql.com/org)
126-
2. Publish the `api.schema` to the graph you created, _you should see a modal pop up with the command information you need - make sure to save the API key as you'll use it again_
127-
128-
```
129-
APOLLO_KEY=service:my-new-graph:V9_dIUACHIQh5VnhW21SXg \
130-
rover subgraph publish my-new-graph@current \
131-
--schema ./api.graphql \
132-
--name thespacedevs \
133-
--routing-url https://thespacedevs-production.up.railway.app/
134-
```
135-
136-
3. Create a new [Persisted Queries List (PQL)](https://www.apollographql.com/docs/graphos/platform/security/persisted-queries#1-pql-creation-and-linking) for the newly created graph in GraphOS. Make sure to link it to your current variant.
137-
4. Publish operations to PQL in GraphOS
138-
139-
```
140-
rover persisted-queries publish \
141-
--graph-id my-new-graph \
142-
--list-id "PQL-ID" \
143-
--manifest ./persisted_queries/apollo.json
144-
```
145-
146-
_Note: If you added new operations to the operations folder, you'll need to re-generate the persisted queries manifest. There is a VS Code Task you can use in the command palette "Tasks: Run Task" that runs the following command:_
147-
148-
```
149-
npx @apollo/generate-persisted-query-manifest \
150-
generate-persisted-query-manifest \
151-
--config persisted_queries.config.json
152-
```
153-
154-
5. In the command invoking or starting up your Apollo MCP Server with SSE, you'll need to export your `APOLLO_KEY` from the second step along with `APOLLO_GRAPH_REF=my-new-graph@current`.
155-
156-
```bash
157-
export APOLLO_KEY=service:my-new-graph:V9_dIUACHIQh5VnhW21SXg
158-
export APOLLO_GRAPH_REF=my-new-graph@current
159-
```
160-
161-
6. Modify your Apollo MCP Server configuration to use the manifest option instead of operations.
162-
163-
```json
164-
{
165-
"mcpServers": {
166-
"thespacedevs": {
167-
"command": "/Users/michaelwatson/Documents/GitHub/apollographql/apollo-mcp-server/target/debug/apollo-mcp-server",
168-
"args": [
169-
"--directory",
170-
"/Users/michaelwatson/Documents/GitHub/apollographql/mcp-apollo/graphql/TheSpaceDevs",
171-
"--schema",
172-
"api.graphql",
173-
"--manifest",
174-
"persisted_queries/apollo.json",
175-
"--endpoint",
176-
"https://thespacedevs-production.up.railway.app/",
177-
"--introspection"
178-
]
179-
}
180-
}
181-
}
182-
```

0 commit comments

Comments
 (0)