Docs: add section on overriding config options with environment variables #332
Style Review Completed
The pull request has 7 style issues.
Duration: 698ms
PR URL: #332
Review Comments: The AI has posted 7 inline comments with suggestions
Summary of changes:
The documentation was updated to use the imperative mood for instructions, remove redundant phrasing, and correct the formatting of string values within code font.
Annotations
Check warning on line 8 in docs/source/config-file.mdx
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).
```
Check notice on line 10 in docs/source/config-file.mdx
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).
```
Check warning on line 95 in docs/source/config-file.mdx
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).
```
Check warning on line 228 in docs/source/config-file.mdx
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.
```
Check warning on line 230 in docs/source/config-file.mdx
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.
```
Check warning on line 236 in docs/source/config-file.mdx
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.
```
Check warning on line 238 in docs/source/config-file.mdx
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.
```