clarify headers option, fix header name, add link

mabuyo · mabuyo · commit 4f7baaa6798b · 2025-10-24T14:20:35.000-04:00
diff --git a/docs/source/best-practices.mdx b/docs/source/best-practices.mdx
@@ -26,4 +26,4 @@ In particular, we strongly recommend contract variants when using:
 
 If you register a persisted query with a specific client name instead of `null`, you must configure the MCP Server to send the necessary header indicating the client name to the router.
 
-Use the `headers` option when running the MCP Server to pass the header to the router. The default name of the header expected by the router is `apollographql-client-name`. To use a different header name, configure `telemetry.apollo.client_name_header` in router YAML configuration.
+Use [the `headers` option](/apollo-mcp-server/config-file#headers) when running the MCP Server to pass the header to the router. The default name of the header expected by the router is `apollographql-client-name`. To use a different header name, configure `telemetry.apollo.client_name_header` in router YAML configuration.
diff --git a/docs/source/config-file.mdx b/docs/source/config-file.mdx
@@ -46,10 +46,10 @@ These fields are under the top-level `graphos` key and define your GraphOS graph
 
 ### Headers
 
-The `headers` option allows you to specify a list of hard-coded headers and values to include in all GraphQL requests.
+The `headers` option allows you to specify a list of static, hard-coded headers and value. These headers are included in all GraphQL requests.
 
 ```yaml title="mcp.yaml"
-headers: { "apollo-client-name": "my-mcp-server" }
+headers: { "apollographql-client-name": "my-mcp-server" }
 ```
 
 To forward header values from the client, use the [forward headers](#forward-headers) option.

Original file line number	Diff line number	Diff line change
`@@ -26,4 +26,4 @@ In particular, we strongly recommend contract variants when using:`
`26`	`26`
`27`	`27`	If you register a persisted query with a specific client name instead of `null`, you must configure the MCP Server to send the necessary header indicating the client name to the router.
`28`	`28`
`29`		-Use the `headers` option when running the MCP Server to pass the header to the router. The default name of the header expected by the router is `apollographql-client-name`. To use a different header name, configure `telemetry.apollo.client_name_header` in router YAML configuration.
	`29`	+Use [the `headers` option](/apollo-mcp-server/config-file#headers) when running the MCP Server to pass the header to the router. The default name of the header expected by the router is `apollographql-client-name`. To use a different header name, configure `telemetry.apollo.client_name_header` in router YAML configuration.