Skip to content

Commit b750551

Browse files
authored
Merge pull request #201 from apollographql/pubmodmatt/search_doc
Add documentation for the search tool
2 parents 0271cf3 + a33d0df commit b750551

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

docs/source/best-practices.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ When running Apollo MCP Server with GraphOS, use contract variants whenever poss
1818
In particular, we strongly recommend contract variants when using:
1919

2020
- [GraphOS-managed persisted queries](/apollo-mcp-server/guides#from-graphos-managed-persisted-queries)
21-
- [Introspection](/apollo-mcp-server/guides#from-schema-introspection)
21+
- [Introspection](/apollo-mcp-server/guides#introspection-tools)
2222

2323
## Send client name header when using persisted queries
2424

docs/source/guides/index.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,13 +153,14 @@ If you register a persisted query with a specific client name instead of `null`,
153153

154154
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.
155155

156-
### From schema introspection
156+
## Introspection tools
157157

158-
For use cases where not all operations can be pre-defined, Apollo MCP Server supports tool creation based on introspection of the graph schema. This allows AI agents to explore a graph and execute operations dynamically.
158+
In addition to defining specific tools for pre-defined GraphQL operations, Apollo MCP Server supports introspection tools that enable AI agents to explore the graph schema and execute operations dynamically.
159159

160-
To enable these schema-aware tools, run the MCP Server with the `introspection` option, which exposes two new tools:
160+
You can enable the following introspection tools:
161161

162-
- `introspect` - returns information about schema types
162+
- `introspect` - allows the AI model to introspect the schema of the GraphQL API by providing a specific type name to get information about, and a depth parameter to determine how deep to traverse the subtype hierarchy. The AI model can start the introspection by looking up the top-level `Query` or `Mutation` type.
163+
- `search` - allows the AI model to search for type information by providing a set of search terms. This can result in fewer tool calls than `introspect`, especially if the desired type is deep in the type hierarchy of the schema. Search results include all the parent type information needed to construct operations involving the matching type.
163164
- `execute` - executes an operation on the GraphQL endpoint
164165

165166
The MCP client can use these tools to provide schema information to the model and its context window, and allow the model to execute GraphQL operations based on that schema.

docs/source/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ If you're still having issues:
189189
See the [user guide](/apollo-mcp-server/guides) to learn how to create tools from:
190190
- [Operation files](/apollo-mcp-server/guides#from-operation-files)
191191
- [Persisted query manifests](/apollo-mcp-server/guides/#from-persisted-query-manifests)
192-
- [Schema introspection](/apollo-mcp-server/guides/#from-schema-introspection)
192+
- [Schema introspection](/apollo-mcp-server/guides/#introspection-tools)
193193

194194
When you are ready, [deploy the MCP server](https://www.apollographql.com/docs/apollo-mcp-server/guides#deploying-the-mcp-server).
195195

0 commit comments

Comments
 (0)