Skip to content

Commit b16f07d

Browse files
committed
copy changes for clarity and simplicity
1 parent c10322b commit b16f07d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/source/command-reference.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,14 @@ iwr 'https://mcp.apollo.dev/download/win/v0.6.1' | iex
8787

8888
## Usage
8989

90-
Configure the Apollo MCP server with a YAML configuration file. The path to this file is the only argument.
91-
A configuration file is not required, but if one is not provided environment variables for your Apollo Graph Reference and Apollo Key are needed.
90+
Configure the Apollo MCP server with a YAML configuration file.
9291

9392
```sh showLineNumbers=false
9493
apollo-mcp-server [OPTIONS] <PATH/TO/CONFIG/FILE>
9594
```
9695

96+
A configuration file is optional. If the file is not provided, environment variables for your graph credentials (`APOLLO_GRAPH_REF` and `APOLLO_KEY`) are required for the server to run.
97+
9798
### CLI options
9899

99100
| Option | Description |
@@ -103,17 +104,16 @@ apollo-mcp-server [OPTIONS] <PATH/TO/CONFIG/FILE>
103104

104105
### Example config file
105106

106-
Detailed options for your configuration file are below, but this is an example configuration file.
107-
This file sets your endpoint to `localhost:4001`, configures transport over Streamable HTTP, provides a GraphOS key and graph reference,
107+
The following example file sets your endpoint to `localhost:4001`, configures transport over Streamable HTTP, provides a GraphOS key and graph reference,
108108
enables introspection, and provides two local MCP operations for the server to expose.
109109

110110
```yaml config.yaml
111111
endpoint: http://localhost:4001/
112112
transport:
113113
type: streamable_http
114114
graphos:
115-
apollo_key: <YOUR_KEY>
116-
apollo_graph_ref: <YOUR_GRAPH>
115+
apollo_key: <YOUR_APOLLO_KEY>
116+
apollo_graph_ref: <YOUR_APOLLO_GRAPH_REF>
117117
introspection:
118118
introspect:
119119
enabled: true
@@ -126,7 +126,7 @@ operations:
126126
127127
### Config options
128128
129-
All fields are optional and have sensible default values.
129+
All fields are optional.
130130
131131
| Option | Type | Default | Description |
132132
| :--------------- | :-------------------- | :----------------------- | :------------------------------------------------------------ |
@@ -144,7 +144,7 @@ All fields are optional and have sensible default values.
144144

145145
#### GraphOS configuration
146146

147-
These fields are under the top-level `graphos` key and define credentials and other details related to GraphOS.
147+
These fields are under the top-level `graphos` key and define your GraphOS graph credentials and endpoints.
148148

149149
| Option | Type | Default | Description |
150150
| :------------------------ | :------- | :------ | :-------------------------------------------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)