Sourcegraph MCP Server

Connect AI agents and applications to your Sourcegraph instance's code search and analysis capabilities.

Supported on Enterprise plans.

The Sourcegraph Model Context Protocol (MCP) Server provides AI agents and applications with programmatic access to your Sourcegraph instance's code search, navigation, and analysis capabilities through a standardized interface.

Server Endpoints

The MCP server provides different tool suites for various use cases:

EndpointDescription
/.api/mcpFull suite of Sourcegraph tools
/.api/mcp/deepsearchDeep Search agent

Example URL:

SHELL
https://your-sourcegraph-instance.com/.api/mcp

Getting Started

MCP clients that support OAuth can connect directly—just point them at your Sourcegraph instance and authenticate through your browser:

Amp

BASH
amp mcp add sg https://sourcegraph.example.com/.api/mcp

Claude Code

BASH
claude mcp add --transport http sg https://sourcegraph.example.com/.api/mcp

This works similarly for other MCP-compatible agents. See Client Integration for detailed setup instructions for each client.

Authentication

The MCP server supports OAuth 2.0 and access token authentication.

OAuth 2.0

Sourcegraph implements Dynamic Client Registration (RFC 7591), so compatible clients can authenticate automatically without pre-configured client IDs. DCR-registered applications are restricted to the mcp scope, which limits access to MCP endpoints only.

Access Tokens

Alternatively, include an access token in the Authorization header:

SHELL
Authorization: token YOUR_ACCESS_TOKEN

Access tokens can use the mcp scope to restrict access to MCP endpoints only.

Client Integration

The Sourcegraph MCP server can be integrated with various AI tools and IDEs that support the Model Context Protocol.

Supported Clients

Amp

To create an access token, visit Creating an access token.

You can add the Sourcegraph MCP server to Amp in two ways:

Option 1: VSCode settings.json

  1. Open VSCode's settings.json file.

  2. Add the following configuration:

    JSON
    { "amp.mcpServers": { "sourcegraph": { "url": "https://your-sourcegraph-instance.com/.api/mcp", "headers": { "Authorization": "token YOUR_ACCESS_TOKEN" } } } }

    Replace your-sourcegraph-instance.com with your Sourcegraph instance URL and YOUR_ACCESS_TOKEN with your access token.

  3. Save the configuration file.

  4. Restart VS Code to apply the new configuration.

Option 2: Amp CLI

Run the following command in your terminal:

BASH
amp mcp add sourcegraph --header "Authorization=token YOUR_ACCESS_TOKEN" https://sourcegraph.sourcegraph.com/.api/mcp

Replace sourcegraph.sourcegraph.com with your Sourcegraph instance URL and set YOUR_ACCESS_TOKEN environment variable to your access token.

Claude Code

You can add the Sourcegraph MCP server to Claude Code in two ways:

Option 1: Project-scoped server (via .mcp.json file)

  1. Create a .mcp.json file in your project root if it doesn't exist.

  2. Add the following configuration:

    JSON
    { "mcpServers": { "sourcegraph": { "type": "http", "url": "https://your-sourcegraph-instance.com/.api/mcp", "headers": { "Authorization": "token YOUR_ACCESS_TOKEN" } } } }

    Replace your-sourcegraph-instance.com with your Sourcegraph instance URL and YOUR_ACCESS_TOKEN with your access token.

  3. Save the configuration file.

  4. Restart Claude Code to apply the new configuration.

Option 2: Locally-scoped server (via CLI command)

You can also add the Sourcegraph MCP server as a locally-scoped server, which is only available to you in the current project:

  1. Run the following command in your terminal:

    BASH
    claude mcp add --transport http sourcegraph https://your-sourcegraph-instance.com/.api/mcp \ --header "Authorization: token YOUR_ACCESS_TOKEN"

    Replace your-sourcegraph-instance.com with your Sourcegraph instance URL and YOUR_ACCESS_TOKEN with your access token.

Locally-scoped servers take precedence over project-scoped servers with the same name and are stored in your project-specific user settings.

Google Gemini Code Assist

You can add the Sourcegraph MCP server to Google Gemini Code Assist by configuring the .gemini/settings.json file:

  1. Open or create the configuration file at ~/.gemini/settings.json (or the equivalent path on your system).

  2. Add the following configuration:

    JSON
    { "mcpServers": { "sourcegraph": { "httpUrl": "https://your-sourcegraph-instance.com/.api/mcp", "headers": { "Authorization": "token YOUR_ACCESS_TOKEN" } } } }

    Replace your-sourcegraph-instance.com with your Sourcegraph instance URL and YOUR_ACCESS_TOKEN with your access token.

  3. Save the configuration file.

  4. Restart Gemini Code Assist to apply the new configuration.

VS Code

You can add the Sourcegraph MCP server to VS Code in one of two ways:

Option 1: code CLI

  1. Run the following command to add the MCP server to the global configuration
BASH
code --add-mcp "{ \"name\": \"sourcegraph\", \"type\": \"remote\", \"url\": \"https://your-sourcegraph-instance.com/.api/mcp\" }"
  1. Launch or restart VS Code to apply the new configuration.

Option 2: VSCode mcp.json

  1. Create .vscode/mcp.json in your project.

  2. Add the following configuration:

    JSON
    { "servers": { "sourcegraph": { "type": "http", "url": "https://your-sourcegraph-instance.com/.api/mcp", } }, "inputs": [] }
  3. Save the configuration file.

  4. Restart VS Code to apply the new configuration.

Cursor

  1. Open or create the MCP configuration file at ~/.cursor/mcp.json (or the equivalent path on your system).

  2. Add the following:

    JSON
    { "mcpServers": { "sourcegraph": { "url": "https://your-sourcegraph-instance.com/.api/mcp", "type": "http", "headers": { "Authorization": "token YOUR_ACCESS_TOKEN" } } } }

    Replace your-sourcegraph-instance.com with your Sourcegraph instance URL and YOUR_ACCESS_TOKEN with your access token.

  3. Save the configuration file.

  4. Restart Cursor to apply the new configuration.

Antigravity

  1. Create ⁠.vscode/mcp.json (Antigravity uses .vscode for configs) in your project.

  2. Add the following:

    JSON
    { "servers": { "sourcegraph": { "url": "https://your-sourcegraph-instance.com/.api/mcp", "type": "http", "headers": { "Authorization": "token YOUR_ACCESS_TOKEN" } } }, "inputs": [] }

    Replace your-sourcegraph-instance.com with your Sourcegraph instance URL and YOUR_ACCESS_TOKEN with your access token.

Windsurf

  1. Create ⁠~/.codeium/windsurf/mcp_config.json.

  2. Add the following:

    JSON
    { "mcpServers": { "sourcegraph": { "serverUrl": "https://your-sourcegraph-instance.com/.api/mcp", "headers": { "Authorization": "token YOUR_ACCESS_TOKEN", "Content-Type": "application/json" } } } }

    Replace your-sourcegraph-instance.com with your Sourcegraph instance URL and YOUR_ACCESS_TOKEN with your access token.

  3. Save the configuration file.

OpenCode

You can add the Sourcegraph MCP server to OpenCode by configuring it in your MCP settings file:

  1. Open or create the MCP configuration file at ~/.config/opencode/opencode.jsonc (or the equivalent path on your system).

  2. Add the following configuration:

    JSON
    { "mcp": { "sourcegraph": { "type": "remote", "url": "https://your-sourcegraph-instance.com/.api/mcp", "oauth": false, "headers": { "Authorization": "token {env:YOUR_ACCESS_TOKEN}" } } }, "$schema": "https://opencode.ai/config.json" }

    Replace your-sourcegraph-instance.com with your Sourcegraph instance URL and YOUR_ACCESS_TOKEN with your access token.

  3. Save the configuration file.

  4. Restart OpenCode to apply the changes.

Available Tools

All MCP tools implement result limits to ensure efficient operation and prevent context window overflow. These limits are designed to return the most relevant results while maintaining optimal performance. For large result sets, use pagination parameters (after/before cursors) where available, or refine your search with more specific filters.

The MCP server provides these tools for code exploration and analysis:

File & Repository Operations

read_file

Read file contents with line numbers and support for specific ranges and revisions.

Parameters:

  • repo - Repository name (required)
  • path - File path within repository (required)
  • startLine - Starting line number (optional)
  • endLine - Ending line number (optional)
  • revision - Branch, tag, or commit hash (optional)

Use cases: Reading specific files, examining code sections, reviewing different versions

File size limit is 128KB. Use line ranges for larger files.

list_files

List files and directories in a repository path.

Parameters:

  • repo - Repository name (required)
  • path - Directory path (optional, defaults to root)
  • revision - Branch, tag, or commit hash (optional)

list_repos

Search and list repositories by name patterns with pagination support.

Parameters:

  • query - Search pattern for repository names (required)
  • limit - Maximum results per page (optional, default 50)
  • after/before - Pagination cursors (optional)

Perform exact keyword searches with boolean operators and filters.

Parameters:

  • query - Search query with optional filters (required)

Supported filters:

  • repo: - limit to specific repositories
  • file: - search specific file patterns
  • rev: - search specific revisions

Features: Boolean AND/OR operators, regex patterns

Semantic search with flexible linguistic matching.

Parameters:

  • query - Natural language search query (required)

Supported filters:

  • repo: - limit to specific repositories
  • file: - search specific file patterns
  • rev: - search specific revisions

Features: Flexible linguistic matching, stemming, broader results than keyword search

Code Navigation

go_to_definition

Find the definition of a symbol from a usage location.

Parameters:

  • repo - Repository name (required)
  • path - File path containing symbol usage (required)
  • symbol - Symbol name to find definition for (required)
  • revision - Branch, tag, or commit hash (optional)

Features: Cross-repository support, compiler-level accuracy

find_references

Find all references to a symbol from its definition location.

Parameters:

  • repo - Repository name (required)
  • path - File path containing symbol definition (required)
  • symbol - Symbol name to find references for (required)
  • revision - Branch, tag, or commit hash (optional)

Version Control & History

Search commits by message, author, content, files, and date ranges.

Parameters:

  • repos - Array of repository names (required)
  • messageTerms - Terms to search in commit messages (optional)
  • authors - Filter by commit authors (optional)
  • contentTerms - Search in actual code changes (optional)
  • files - Filter by file paths (optional)
  • after/before - Date range filters (optional)

Search actual code changes for specific patterns across repositories.

Parameters:

  • pattern - Search pattern for code changes (required)
  • repos - Array of repository names (required)
  • added - Search only added code (optional)
  • removed - Search only removed code (optional)
  • author - Filter by author (optional)
  • after/before - Date range filters (optional)

compare_revisions

Compare changes between two specific revisions.

Parameters:

  • repo - Repository name (required)
  • base - Base revision (older version) (required)
  • head - Head revision (newer version) (required)
  • first - Maximum file diffs to return (optional, default 50)
  • after - Pagination cursor (optional)

get_contributor_repos

Find repositories where a contributor has made commits.

Parameters:

  • author - Author name or email (required)
  • limit - Maximum repositories to return (optional, default 20)
  • minCommits - Minimum commits required (optional, default 1)

Admins can disable the deepsearch tool on the default and v1 MCP endpoints by setting the environment variable SRC_MCP_DISABLE_DEEPSEARCH_TOOL=true on the Sourcegraph instance. This does not affect deepsearch_read or the dedicated /deepsearch endpoint. This is a temporary measure available in 7.0 and will be replaced by a proper tool allowlist in a future release.

deepsearch

Create a new Deep Search conversation to answer complex questions about your codebase.

Parameters:

  • question - The question to research using Deep Search (required). Should be detailed and specific about what you want to understand.

Use cases: Comprehensive analysis of complex technical questions, multi-step research across one or many remote codebases, detailed explanations with supporting evidence, questions that require combining information from multiple sources

deepsearch_read

Read a Deep Search conversation and return the markdown content of the questions and answers.

Parameters:

  • identifier - The Deep Search conversation identifier (required). Can be:
    • A full Sourcegraph Deep Search URL (e.g., https://sourcegraph.com/deepsearch/abc123 or https://sourcegraph.com/deepsearch/shared/abc123)
    • A read token (e.g., abc123-def456-...)

Use cases: Reading or re-opening Deep Search results, summarizing existing answers, using past Deep Search as context for new questions

Usage Examples

Finding Authentication Code

JSON
{ "method": "tools/call", "params": { "name": "nls_search", "arguments": { "query": "authentication login user" } } }

Reading a Specific File

JSON
{ "method": "tools/call", "params": { "name": "read_file", "arguments": { "repo": "github.com/myorg/myrepo", "path": "src/auth/login.go", "startLine": 1, "endLine": 50 } } }

Finding Recent Changes

JSON
{ "method": "tools/call", "params": { "name": "commit_search", "arguments": { "repos": ["github.com/myorg/myrepo"], "messageTerms": ["bug fix"], "after": "1 week ago" } } }

Best Practices

  1. Repository Scoping: Use list_repos first to find relevant repositories for better performance
  2. Progressive Search: Start with broad searches (nls_search) then narrow with specific tools
  3. File Verification: Use list_files before read_file to verify file existence
  4. Pagination: Use after/before cursors for large result sets
  5. Tool Combinations: Chain tools together (e.g., list_reposcommit_search)
Previous
Debug API