Command Reference

experimental
This feature is experimental. Your questions and feedback are highly valued—don't hesitate to get in touch with your Apollo contact or post in the Apollo Community MCP Server Category.

Installation

Container

A container is built for the Apollo MCP Server with every release at ghcr.io/apollographql/apollo-mcp-server.

Available tags include the following:

  • latest: The latest versioned release, including release candidates

  • v<VERSION>: The fixed release version

  • v<VERSION>-rc.<NUMBER>: The fixed release candidate of the specified version

note
The container sets a few defaults for ease of use:
  • Working Directory is /data: Make sure to mount static schemas / operations to this location using the volume flag when running (-v / --version).
  • HTTP Streamable Transport on port 5000: Make sure to export container port 5000 for HTTP Streamable connections to the MCP server using the port flag when running (-p / --port)

Linux / MacOS installer

To install or upgrade to the latest release of Apollo MCP Server:

sh
curl -sSL https://mcp.apollo.dev/download/nix/latest | sh

To install or upgrade to a specific version of Apollo MCP Server (recommended for CI environments to ensure predictable behavior):

Bash
1# Note the `v` prefixing the version number
2curl -sSL https://mcp.apollo.dev/download/nix/v0.3.0| sh

If your machine doesn't have the curl command, you can get the latest version from the curl downloads page.

note
These installation methods currently don't support Intel-based Macs. Support is planned for a future release.

Windows PowerShell installer

To install or upgrade to the latest release of Apollo MCP Server:

Bash
1iwr 'https://mcp.apollo.dev/download/win/latest' | iex

To install or upgrade to a specific version of Apollo MCP Server (recommended for CI environments to ensure predictable behavior):

Bash
1# Note the `v` prefixing the version number
2iwr 'https://mcp.apollo.dev/download/win/v0.3.0' | iex

Download container image

To pull the latest release docker container of Apollo MCP Server:

Bash
1docker image pull ghcr.io/apollographql/apollo-mcp-server:latest

To pull a specific version of Apollo MCP Server (recommended for CI environments to ensure predictable behavior):

Bash
1# Note the `v` prefixing the version number
2docker image pull ghcr.io/apollographql/apollo-mcp-server:v0.3.0

Usage

sh
apollo-mcp-server [OPTIONS] --directory <DIRECTORY>

Options

OptionDescription
-d, --directory <DIRECTORY>The working directory to use. Defaults the current working directory.
-s, --schema <SCHEMA>The path to the GraphQL API schema file.
-c, --custom-scalars-config <CUSTOM_SCALARS_CONFIG>The path to the GraphQL custom_scalars_config file.
-e, --endpoint <ENDPOINT>The GraphQL endpoint the server will invoke.
[default: http://127.0.0.1:4000]
--header <HEADERS>Headers to send to the endpoint.
--sse-port <SSE_PORT>Start the server using the SSE transport on the given port (default: 5000).
--sse-address <SSE_ADDRESS>The IP address to bind the SSE server to (default: 127.0.0.1).
--http-port <HTTP_PORT>Start the server using the Streamable HTTP transport on the given port (default: 5000).
--http-address <HTTP_ADDRESS>The IP address to bind the Streamable HTTP server to (default: 127.0.0.1).
-i, --introspectionExpose the schema to the MCP client through introspect and execute tools. Learn more.
-u, --uplinkEnable use of uplink to get the schema and persisted queries (requires APOLLO_KEY and APOLLO_GRAPH_REF). Learn more.
-x, --explorerExpose a tool to open queries in Apollo Explorer (requires APOLLO_KEY and APOLLO_GRAPH_REF).
-o, --operations [<OPERATIONS>...]Operation files to expose as MCP tools. Learn more.
--manifest <MANIFEST>The path to the persisted query manifest containing operations.
--disable-type-descriptionDisable operation root field types in tool description.
--disable-schema-descriptionDisable schema type definitions referenced by all fields returned by the operation in the tool description.
-m, --allow-mutations <ALLOW_MUTATIONS>[default: none]

Possible values:
  • none: Don't allow any mutations
  • explicit: Allow explicit mutations, but don't allow the LLM to build them
  • all: Allow the LLM to build mutations
-l, --log <LOG_LEVEL>[default: INFO]

Possible values:
  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR
-h, --helpPrint help (see a summary with -h).

Specifying either the SSE port or address (or both) will enable the SSE transport. Specifying either the HTTP port or address (or both) will enable the Streamable HTTP transport.

Mapping rover dev options

You can use the rover dev command of Rover CLI v0.32 or later to run an Apollo MCP Server instance for local development.

Running rover dev --mcp starts an MCP Server. Additional options, --mcp*, directly configure the MCP Server.

The mapping of rover dev options to MCP Server options:

rover dev optionEquivalent MCP Server option
--mcp-directory <DIRECTORY>-d, --directory <DIRECTORY>
--mcp-port <PORT>--http-port <PORT>
--mcp-address <ADDRESS>--http-address <ADDRESS>
--mcp-introspection-i, --introspection
--mcp-uplink-u, --uplink
--mcp-operations [<OPERATIONS>...]-o, --operations [<OPERATIONS>...]
--mcp-header <HEADERS>--header <HEADERS>
--mcp-manifest <MANIFEST>--manifest <MANIFEST>
--mcp-custom-scalars-config <CUSTOM_SCALARS_CONFIG>-c, --custom-scalars-config <CUSTOM_SCALARS_CONFIG>
--mcp-allow-mutations <ALLOW_MUTATIONS>-m, --allow-mutations <ALLOW_MUTATIONS>
--mcp-disable-type-description--disable-type-description
--mcp-disable-schema-description--disable-schema-description
Feedback

Edit on GitHub

Ask Community