Style Review Completed
The pull request has 6 style issues.
Duration: 717ms
PR URL: #536
Review Comments: The AI has posted 6 inline comments with suggestions
Summary of changes:
The documentation was updated to apply code font to specific elements like `StreamableHTTP` and the port number `5000`. Version numbers are now consistently plain text, and phrases like "v1.0.0 and earlier" are used for clarity. Several sections were revised to use active voice, present tense, and concise language, and a comma splice was corrected.
Annotations
Check notice on line 224 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L224
Apply code font to `StreamableHTTP` as it refers to a specific type or configuration option.
```suggestion
| "sse" | Host the MCP server on the supplied config, using SSE for communication. Deprecated in favor of `StreamableHTTP` |
```
Check warning on line 238 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L238
Version numbers should be plain text (e.g., v1.0.0) and not use code font. Use "v1.0.0 and earlier" for better readability than the symbol `≤`. Apply code font to the port number `5000`. Use active voice ("changed" instead of "was changed").
```suggestion
For Apollo MCP Server v1.0.0 and earlier, the default `port` value is `5000`. In v1.1.0, the default `port` option changed to `8000` to avoid conflicts with common development tools and services that typically use port `5000` (such as macOS AirPlay, Flask development servers, and other local services).
```
Check notice on line 322 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L322
Use the active voice and concise language.
```suggestion
| `omitted_attributes` | `List<String>` | | List of attributes to omit from metrics. |
```
Check notice on line 379 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L379
Use the active voice and concise language.
```suggestion
| `omitted_attributes` | `List<String>` | | List of attributes to omit from traces. |
```
Check warning on line 420 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L420
Use the present tense and active voice.
```suggestion
| `always_on` | `string` | Exports all traces. |
```
Check warning on line 421 in docs/source/config-file.mdx
apollo-librarian / AI Style Review
docs/source/config-file.mdx#L421
Use the present tense and active voice. This also fixes a comma splice.
```suggestion
| `always_off` | `string` | Disables sampling. Does not export traces. |
```