Skip to content

command-reference.mdx

Latest commit

 

History

History
145 lines (105 loc) · 11.9 KB

command-reference.mdx

File metadata and controls

145 lines (105 loc) · 11.9 KB
Raw
title Command Reference
subtitle
description Reference guide of options for running Apollo MCP Server.

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 Methods

Download container image

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

To download the latest release Docker container of Apollo MCP Server:

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

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

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

To download a specific version of Apollo MCP Server that is a release candidate:

# Note the `v` prefixing the version number and the `-rc` suffix
docker image pull ghcr.io/apollographql/apollo-mcp-server:v0.4.1-rc.1

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)

Apollo Runtime Container

The Apollo Runtime Container runs both the MCP Server and the Apollo Router in a single container. It's useful for local development, testing, and production deployments.

Learn more about deploying and configuring this container in the Runtime Container repository.

Linux / MacOS installer

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

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):

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

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

Windows PowerShell installer

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

iwr '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):

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

Usage

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

Options

Option Description
-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. Learn more.
-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, --introspection Expose the schema to the MCP client through introspect and execute tools. Learn more.
--uplink-manifest Enable use of uplink to get the persisted queries (requires APOLLO_KEY and APOLLO_GRAPH_REF). Learn more.
-x, --explorer Expose a tool that returns the URL to open a GraphQL operation in Apollo Explorer (requires 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.
--collection <COLLECTION_ID> The ID of an operation collection to use as the source for operations (requires APOLLO_KEY). If default is used instead of an ID, the MCP Tools for APOLLO_GRAPH_REF will be used as the source.
--disable-type-description Disable operation root field types in tool description.
--disable-schema-description Disable 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, --help Print help (see a summary with -h).
-V, --version Print version

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 option Equivalent 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-manifest -u, --uplink-manifest
--mcp-operations [<OPERATIONS>...] -o, --operations [<OPERATIONS>...]
--mcp-header <HEADERS> --header <HEADERS>
--mcp-manifest <MANIFEST> --manifest <MANIFEST>
--mcp-collection <COLLECTION_ID> --collection <COLLECTION_ID>
--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