Releasing 0.9.0#377
Style Review Completed
The pull request has 34 style issues.
Duration: 2411ms
PR URL: #377
Review Comments: The AI has posted 34 inline comments with suggestions
Summary of changes:
The documentation has been updated to improve clarity, conciseness, and grammatical consistency. Key changes include: using present tense for descriptions and active voice for clarity; using imperative verbs for headings in tutorials and how-to guides; standardizing the use of code font for HTTP header names; replacing informal phrases and idioms with more precise language; avoiding bold and italics for emphasis; and ensuring consistent grammar and phrasing throughout the text.
Annotations
Check notice on line 171 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L171
Use present tense for descriptions. The phrase "on the configuration" is unclear and has been removed.
```suggestion
| <code>type</code> | <code>"streamable_http"</code> | | Hosts the MCP server using streamable HTTP messages. |
```
Check notice on line 193 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L193
Use "for" instead of "relating to" for conciseness.
```suggestion
| <code>resource_documentation</code> | <code>string</code> | | Optional link to more documentation for this MCP server |
```
Check notice on line 195 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L195
Use code font for the `Authorization` header name. Added articles for clarity.
```suggestion
| <code>disable_auth_token_passthrough</code> | <code>bool</code> | <code>false</code> | Optional flag to disable passing the validated <code>Authorization</code> header to the downstream API. |
```
Check notice on line 272 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L272
Use active voice and present tense for clarity and conciseness.
```suggestion
| <code>always_off</code> | <code>string</code> | Disables sampling and prevents traces from being exported. |
```
Check warning on line 5 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L5
For tutorials and how-to guides, headings should use imperative verbs.
```suggestion
## Configure CORS
```
Check warning on line 11 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L11
Do not use bold for emphasis.
```suggestion
This article describes CORS configuration that's specific to Apollo MCP Server. For a more general introduction to CORS and common considerations, see [MDN's CORS documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS).
```
Check warning on line 18 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L18
Avoid idioms like "comes in handy" for clarity, especially for non-native English speakers.
```suggestion
- This option is useful for matching origins against a pattern, such as matching subdomains of a specific namespace.
```
Check warning on line 22 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L22
Do not use italics for emphasis.
```suggestion
- If clients need to authenticate their requests with cookies, you must use either <code>origins</code>, <code>match_origins</code>, or a combination of both options. When using both, note that <code>origins</code> is evaluated before <code>match_origins</code>.
```
Check warning on line 59 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L59
Do not use italics for emphasis.
```suggestion
If your MCP server serves exclusively non-browser-based clients, you probably don't need to enable CORS configuration.
```
Check warning on line 61 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L61
For tutorials and how-to guides, headings should use imperative verbs.
```suggestion
### Pass credentials
```
Check notice on line 63 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L63
The phrase "tell the browser" is informal. "Indicate to the browser" is more precise.
```suggestion
If your MCP server requires requests to include a user's credentials (e.g., via cookies), you need to modify your CORS configuration to indicate to the browser that credentials are allowed.
```
Check notice on line 65 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L65
Use code font for HTTP header names for consistency.
```suggestion
You can enable credentials with CORS by setting the <code>Access-Control-Allow-Credentials</code> HTTP header to <code>true</code>.
```
Check notice on line 67 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L67
The phrase "like so" is informal.
```suggestion
To allow browsers to pass credentials to the server, set <code>allow_credentials</code> to <code>true</code>:
```
Check warning on line 77 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L77
Do not use bold for emphasis. Use present tense for clarity.
```suggestion
To support credentialed requests, your server's config file must specify individual <code>origins</code> or <code>match_origins</code>. If your server enables <code>allow_any_origin</code>, your browser refuses to send credentials.
```
Check warning on line 137 in docs/source/cors.mdx
apollo-librarian / AI Style Review
docs/source/cors.mdx#L137
For tutorials and how-to guides, headings should use imperative verbs.
```suggestion
### Match origins
```
Check warning on line 57 in docs/source/define-tools.mdx
apollo-librarian / AI Style Review
docs/source/define-tools.mdx#L57
For tutorials and how-to guides, headings should use imperative verbs.
```suggestion
#### Configure the MCP Server to use a GraphOS operation collection
```
Check warning on line 73 in docs/source/define-tools.mdx
apollo-librarian / AI Style Review
docs/source/define-tools.mdx#L73
For tutorials and how-to guides, headings should use imperative verbs.
```suggestion
#### Set operation collection variables
```
Check warning on line 60 in docs/source/deploy.mdx
apollo-librarian / AI Style Review
docs/source/deploy.mdx#L60
For instructional sections, headings should use imperative verbs.
```suggestion
### Use a load balancer
```
Check warning on line 62 in docs/source/deploy.mdx
apollo-librarian / AI Style Review
docs/source/deploy.mdx#L62
Do not use italics for emphasis.
```suggestion
Because [MCP is a stateful protocol](https://modelcontextprotocol.io/docs/learn/architecture#lifecycle-management), you need to configure your load balancer to keep each session on the same server instance.
```
Check notice on line 66 in docs/source/deploy.mdx
apollo-librarian / AI Style Review
docs/source/deploy.mdx#L66
Use "ID" when referring to an identifier generically.
```suggestion
If the load balancer routes subsequent requests to a different instance, Apollo MCP Server rejects the request because it doesn't recognize the session ID.
```
Check notice on line 68 in docs/source/deploy.mdx
apollo-librarian / AI Style Review
docs/source/deploy.mdx#L68
The phrase "If yours does not" is slightly ambiguous. Specifying "your load balancer" is clearer.
```suggestion
Many load balancers offered by major cloud vendors don't support header-based session affinity. If your load balancer doesn't, use software such as Nginx, HAProxy, or Envoy/Istio in front of the Apollo MCP Server instances.
```
Check warning on line 230 in docs/source/guides/auth-auth0.mdx
apollo-librarian / AI Style Review
docs/source/guides/auth-auth0.mdx#L230
Avoid using "we" unless it unambiguously refers to Apollo. Use "enables" instead of "allows".
```suggestion
This guide uses [Goose](https://block.github.io/goose/) as its MCP Client. Goose enables you to choose between many different LLMs and provides some built-in functionality for connecting to MCP servers, called [Extensions](https://block.github.io/goose/docs/getting-started/using-extensions).
```
Check notice on line 232 in docs/source/guides/auth-auth0.mdx
apollo-librarian / AI Style Review
docs/source/guides/auth-auth0.mdx#L232
The "-->" symbol is unconventional. Describing the action is clearer. Added the Oxford comma for consistency.
```suggestion
[Install the Goose CLI](https://block.github.io/goose/docs/getting-started/installation), following the instructions for your operating system. Set up the LLM provider of your choice by running <code>goose configure</code> and selecting **Configure Providers**. Each provider has its own set of instructions, rate limiting, and pricing.
```
Check notice on line 247 in docs/source/guides/auth-auth0.mdx
apollo-librarian / AI Style Review
docs/source/guides/auth-auth0.mdx#L247
Use present tense and more formal language. "send you through the auth flow" is informal.
```suggestion
1. To start Goose, type <code>goose</code>. This opens a browser window and initiates the authentication flow.
```
Check notice on line 249 in docs/source/guides/auth-auth0.mdx
apollo-librarian / AI Style Review
docs/source/guides/auth-auth0.mdx#L249
The phrase "fails as unauthenticated" is awkward. "fails without the proper authentication token" is clearer.
```suggestion
1. In Goose, ask "What astronauts are in space right now?". This question is similar to the <code>GetAstronautsCurrentlyInSpace</code> operation from earlier, which fails without the proper authentication token.
```