Skip to content

Docs: add section on overriding config options with environment variables #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 4, 2025
Merged

Docs: add section on overriding config options with environment variables #332

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7b13bf
docs: add section on overriding config options
mabuyo Sep 4, 2025
649a50d
move config file example to bottom, add more link outs to relevant pages
mabuyo Sep 4, 2025
954257c
fix: bool values need to be in string quotes
mabuyo Sep 4, 2025
35f7598
fix: remove graph credentials in example config file (bad practice)
mabuyo Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 43 additions & 23 deletions docs/source/config-file.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,16 @@
- /apollo-mcp-server/command-reference
---

### Example config file
You can configure Apollo MCP Server using a configuration file. You can also [override configuration options using environment variables](#override-configuration-options-using-environment-variables).

Check warning on line 8 in docs/source/config-file.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/config-file.mdx#L8 

Use the imperative mood for instructions to be more direct and authoritative.

```suggestion
Configure Apollo MCP Server using a configuration file. You can also [override configuration options using environment variables](#override-configuration-options-using-environment-variables).
```

The following example file sets your endpoint to `localhost:4001`, configures transport over Streamable HTTP, provides a GraphOS key and graph reference,
enables introspection, and provides two local MCP operations for the server to expose.

```yaml config.yaml
endpoint: http://localhost:4001/
transport:
type: streamable_http
graphos:
apollo_key: <YOUR_APOLLO_KEY>
apollo_graph_ref: <YOUR_APOLLO_GRAPH_REF>
introspection:
introspect:
enabled: true
operations:
source: local
paths:
- relative/path/to/your/operations/userDetails.graphql
- relative/path/to/your/operations/listing.graphql
```
See the [example config file](#example-config-file) for an example.

Check notice on line 10 in docs/source/config-file.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/config-file.mdx#L10 

Avoid redundant phrasing. The link text already indicates it's an example.

```suggestion
See the [example config file](#example-config-file).
```

## Configuration options

All fields are optional.

### Top-level options

| Option | Type | Default | Description |
| :--------------- | :-------------------- | :----------------------- | :--------------------------------------------------------------- |
| `custom_scalars` | `FilePath` | | Path to a [custom scalar map](/apollo-mcp-server/custom-scalars) |
Expand Down Expand Up @@ -58,7 +42,7 @@

### Health checks

These fields are under the top-level `health_check` key.
These fields are under the top-level `health_check` key. Learn more about [health checks](/apollo-mcp-server/health-checks).

| Option | Type | Default | Description |
| :---------------------------- | :--------- | :---------- | :--------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -108,7 +92,7 @@
### Operation source

These fields are under the top-level `operations` key. The available fields depend on the value of the nested `source` key.
The default value for `source` is `"infer"`.
The default value for `source` is `"infer"`. Learn more about [defining tools as operations](/apollo-mcp-server/define-tools).

Check warning on line 95 in docs/source/config-file.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/config-file.mdx#L95 

Do not surround string values with quotes when using code font.

```suggestion
The default value for <code>source</code> is <code>infer</code>. Learn more about [defining tools as operations](/apollo-mcp-server/define-tools).
```

| Source | Option | Type | Default | Description |
| :----------------- | :------- | :--------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
Expand Down Expand Up @@ -179,7 +163,7 @@

### Auth

These fields are under the top-level `transport` key, nested under the `auth` key.
These fields are under the top-level `transport` key, nested under the `auth` key. Learn more about [authorization and authentication](/apollo-mcp-server/auth).

| Option | Type | Default | Description |
| :----------------------- | :------------- | :------ | :------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -220,3 +204,39 @@
- mcp
- profile
```

## Example config file

The following example file sets your endpoint to `localhost:4001`, configures transport over Streamable HTTP, enables introspection, and provides two local MCP operations for the server to expose.

```yaml config.yaml
endpoint: http://localhost:4001/
transport:
type: streamable_http
introspection:
introspect:
enabled: true
operations:
source: local
paths:
- relative/path/to/your/operations/userDetails.graphql
- relative/path/to/your/operations/listing.graphql
```

## Override configuration options using environment variables

You can override configuration options using environment variables. The environment variable name is the same as the option name, but with `APOLLO_MCP_` prefixed. You can use `__` to mark nested options.

Check warning on line 228 in docs/source/config-file.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/config-file.mdx#L228 

Use the imperative mood for instructions to be more direct and authoritative.

```suggestion
Override configuration options using environment variables. The environment variable name is the same as the option name, but with <code>APOLLO_MCP_</code> prefixed. You can use <code>__</code> to mark nested options.
```

For example, to override the `introspection.execute.enabled` option, you can set the `APOLLO_MCP_INTROSPECTION__EXECUTE__ENABLED` environment variable.

Check warning on line 230 in docs/source/config-file.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/config-file.mdx#L230 

Use the imperative mood for instructions to be more direct and actionable.

```suggestion
For example, to override the <code>introspection.execute.enabled</code> option, set the <code>APOLLO_MCP_INTROSPECTION__EXECUTE__ENABLED</code> environment variable.
```

```sh
APOLLO_MCP_INTROSPECTION__EXECUTE__ENABLED="true"
```

For list values, you can set the environment variable to a comma-separated list.

Check warning on line 236 in docs/source/config-file.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/config-file.mdx#L236 

Use the imperative mood for instructions to be more direct and actionable.

```suggestion
For list values, set the environment variable to a comma-separated list.
```

For example, to override the `transport.auth.servers` option, you can set the `APOLLO_MCP_TRANSPORT__AUTH__SERVERS` environment variable to a comma-separated list.

Check warning on line 238 in docs/source/config-file.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/config-file.mdx#L238 

Use the imperative mood for instructions to be more direct and actionable.

```suggestion
For example, to override the <code>transport.auth.servers</code> option, set the <code>APOLLO_MCP_TRANSPORT__AUTH__SERVERS</code> environment variable to a comma-separated list.
```

```sh
APOLLO_MCP_TRANSPORT__AUTH__SERVERS='[server_url_1,server_url_2]'
```