Use Gat MCP in tools

The gat documentation provides a Model Context Protocol (MCP) server. Connect your AI assistant to search the docs for help with commands, storage configuration, and workflows.

Connect your assistant

Each tool connects to the same remote MCP server:

MCP server URL

https://getgat.dev/mcp

Claude
Claude Code
Codex
Cursor
VS Code / Copilot

Add a custom connector

Open Customize → Connectors in Claude, then choose + → Add custom connector. Enter gat as the name and https://getgat.dev/mcp as the remote MCP server URL, then click Add.For a managed workspace, an organization owner may need to add the connector. See Claude’s custom connector setup for account requirements.

Enable it in a conversation

In a chat, open + → Connectors and enable gat. Ask Claude to search the gat documentation using one of the prompts below.

Run this in your terminal to make the server available across projects:

claude mcp add --transport http --scope user gat https://getgat.dev/mcp

Check the connection

Start Claude Code and run /mcp to view the server’s status and tools. Then ask it to search the gat docs.

See Claude Code’s MCP documentation for configuration scopes and server management.

Run this in your terminal:

codex mcp add gat --url https://getgat.dev/mcp

Configure it manually instead

Add this entry to ~/.codex/config.toml:

[mcp_servers.gat]
url = "https://getgat.dev/mcp"

Check the connection

Start a new Codex CLI session and run /mcp to see active servers. Ask Codex to use gat to search the documentation.

See Codex’s MCP documentation for IDE setup and configuration options.

Add the configuration

Create or edit .cursor/mcp.json in your project. Add gat to the mcpServers object, preserving any existing servers:

.cursor/mcp.json

{
  "mcpServers": {
    "gat": {
      "url": "https://getgat.dev/mcp"
    }
  }
}

To use the server across projects, put the configuration in ~/.cursor/mcp.json instead.

Use it in Agent

Open Cursor’s MCP settings and check that gat is available. In an Agent conversation, ask it to search the gat documentation and approve the tool call when prompted.

See Cursor’s MCP documentation for configuration and tool controls.

Add the workspace server

Create or edit .vscode/mcp.json in your project. Add gat to the servers object, preserving any existing servers:

.vscode/mcp.json

{
  "servers": {
    "gat": {
      "type": "http",
      "url": "https://getgat.dev/mcp"
    }
  }
}

Start the server and use it in chat

Run MCP: List Servers from the Command Palette, select gat, and start it. Confirm trust if prompted. Open Copilot Chat in Agent mode and ask it to search the gat documentation.

See VS Code’s MCP documentation for server controls and troubleshooting.

For another MCP client, add a remote HTTP server named gat with the URL above. The settings format depends on the client.

Ask about gat

Try asking your assistant:

“How do I set up an S3 remote with gat?”
“How do I restore large files after switching branches?”
“How do I choose which files to push?”

Ask it to use the gat documentation and link to the relevant pages so you can review the commands and options.

Explore the documentation

Quickstart

Track, upload, and restore your first file.

Set up a remote

Connect object storage or a local directory.

Automatic sync

Restore working files after Git operations.

Path selection

Choose which files to transfer and restore.

Getting Started

Concepts

Guides

References

Commands

Use Gat MCP in tools

Connect your assistant

Ask about gat

Explore the documentation

Quickstart

Set up a remote

Automatic sync

Path selection

​Connect your assistant

​Ask about gat

​Explore the documentation

Quickstart

Set up a remote

Automatic sync

Path selection

Connect your assistant

Ask about gat

Explore the documentation