Conversation
✅ Docs preview readyThe preview is ready to be viewed. View the preview File Changes 0 new, 4 changed, 1 removedBuild ID: b8775eab97d0787dc99e910d URL: https://www.apollographql.com/docs/deploy-preview/b8775eab97d0787dc99e910d
|
|
✅ Changeset file added - thank you! |
|
Hey @mabuyo, could you take a look at the docs? Thanks! |
pragl
left a comment
There was a problem hiding this comment.
Extremely minor copyedits to match our style guide. Otherwise, LGTM!
| | `enable_explorer` | `bool` | `false` | Expose a tool that returns the URL to open a GraphQL operation in Apollo Explorer. Note: This requires a GraphOS graph reference | | ||
| | `mutation_mode` | `oneOf ["none", "explicit", "all"]` | `"none"` | Defines the mutation access level for the MCP server | | ||
| | `descriptions` | `Map<String, String>` | `{}` | Optional map from operation name to tool description. Overrides auto-generated descriptions for any operation source. [Learn more](/apollo-mcp-server/define-tools#config-level-descriptions). | | ||
| | `annotations` | `Map<String, AnnotationOverrides>` | `{}` | Optional map from operation name to MCP tool annotation hints. Merges with auto-detected annotations. See [config-level annotations](/apollo-mcp-server/define-tools#config-level-annotations). | |
There was a problem hiding this comment.
| | `annotations` | `Map<String, AnnotationOverrides>` | `{}` | Optional map from operation name to MCP tool annotation hints. Merges with auto-detected annotations. See [config-level annotations](/apollo-mcp-server/define-tools#config-level-annotations). | | |
| | `annotations` | `Map<String, AnnotationOverrides>` | `{}` | Optional map from operation name to MCP tool annotation hints. Merges with auto-detected annotations. Go to [config-level annotations](/apollo-mcp-server/define-tools#config-level-annotations). | |
| - Queries: `read_only_hint: true`, `destructive_hint: false`, `idempotent_hint: true`, and `open_world_hint: true` | ||
| - Mutations: `read_only_hint: false`, `destructive_hint: true`, and `open_world_hint: true` | ||
|
|
||
| To customize these defaults, add an `annotations` map under the `overrides` config key. Specify only the fields you want to override. |
There was a problem hiding this comment.
| To customize these defaults, add an `annotations` map under the `overrides` config key. Specify only the fields you want to override. | |
| To customize those defaults, add an `annotations` map under the `overrides` config key. Specify only the fields you want to override. |
|
|
||
| ### Config-level annotations | ||
|
|
||
| MCP tool annotations are hints that help AI clients understand tool behavior. Apollo MCP Server auto-detects the following defaults: |
There was a problem hiding this comment.
| MCP tool annotations are hints that help AI clients understand tool behavior. Apollo MCP Server auto-detects the following defaults: | |
| MCP tool annotations are hints that help AI clients understand tool behavior. Apollo MCP Server auto-detects these defaults: |
Closes #679
Allow users to configure MCP tool annotations per operation in the YAML config file under
overrides.annotations. User-specified values are merged with auto-detected defaults.Also set sensible auto-detected defaults for previously unset hints:
idempotent_hint: truefor queries (read-only operations are idempotent)open_world_hint: truefor all operations (GraphQL hits an external API)Testing
Specify annotations in the config file
Set the
titleannotationSet the
idempotent_hintandopen_world_hintannotations