@sourcebot_dev：为 Agent 提供整个代码库的上下文。开源，1 分钟完成安装。

# Sourcebot MCP server - Sourcebot Source: https://docs.sourcebot.dev/docs/features/mcp-server?twclid=24ur7m6qrna8fzx0l5w88rsgef Sourcebot MCP Server 将 AI 工具连接到您的 Sourcebot 部署（https://docs.sourcebot.dev/docs/deployment/docker-compose）。这让 AI 智能体和自动化流程能够在 Sourcebot 托管的所有代码中执行搜索、读取文件、解析引用与定义等操作。 ## 使用场景 - **本地智能体上下文：** 将 MCP 接入 Cursor、Claude Code 或 Copilot 等编码智能体，使其能够获取整个代码库的上下文，而不仅限于当前打开的工作区。 - **构建自主 AI 智能体：** 将 Sourcebot 用作多智能体系统的代码上下文层，实现 PR 审查、自动修复 Bug 以及全公司范围内的问题解答。 ## 快速开始 Sourcebot MCP 采用 Streamable HTTP（https://modelcontextprotocol.io/specification/2025-06-18/basic/transports#streamable-http）传输方式，托管在 `/api/mcp` 路由下。 支持两种授权机制： - **OAuth（推荐）：** 支持 OAuth 2.0 的 MCP 客户端将自动处理授权流程并颁发短期访问令牌。无需 API 密钥或手动管理令牌。仅在有生效的 Enterprise license（https://docs.sourcebot.dev/docs/license-key）时可用。 - **API 密钥：** 任何 MCP 客户端都可以使用 Sourcebot API 密钥进行授权，通过 `Authorization: Bearer` 请求头传递。在 **Settings → API Keys** 中创建。 你可以在 authorization（https://docs.sourcebot.dev/docs/features/mcp-server?twclid=24ur7m6qrna8fzx0l5w88rsgef#authorization）部分阅读更多选项。 Sourcebot MCP server 支持 OAuth 和 API 密钥两种授权方式。如果您的实例启用了 anonymous access（https://docs.sourcebot.dev/docs/configuration/auth/access-settings#anonymous-access），则无需授权。 无论使用哪种方式，所有 MCP 请求都限定于关联的 Sourcebot 用户，并继承该用户的角色与权限（https://docs.sourcebot.dev/docs/configuration/auth/roles-and-permissions）。 当配置了 permission syncing（https://docs.sourcebot.dev/docs/features/permission-syncing）时，这包括代码仓库权限 —— MCP server 仅返回用户有权限访问的仓库结果。 ### OAuth 2.0 Sourcebot 实现了 OAuth 2.0 授权服务器，支持动态客户端注册（RFC 7591）。这意味着 MCP 客户端可以自动完成注册，无需任何手动配置。只需将客户端指向 MCP 端点，它就会处理完整的授权流程：首次连接时会在浏览器中提示您登录并批准访问。无需 API 密钥或手动管理令牌。 授权完成后，Sourcebot 会颁发一个短期访问令牌（有效期 1 小时）和一个刷新令牌（有效期 90 天）。MCP 客户端会自动处理令牌刷新，因此您无需重新授权即可保持连接。 ### API Key（Bearer token） API 密钥提供了比 OAuth 更简单的替代方案，可与任何 MCP 客户端配合使用。每个密钥都限定于创建它的用户，并继承其权限。要创建密钥，请导航至 **Settings → API Keys**，然后点击 **Create API Key**。连接 MCP server 时，将密钥作为 `Authorization: Bearer` 请求头传递。 ### `grep` 在多个仓库中搜索匹配正则表达式模式的代码，类似于 `grep`/`ripgrep`。始终区分大小写。结果按文件分组，并包含行号。 参数： | 名称 | 必填 | 描述 | |---|---|---| | `pattern` | 是 | 要在文件内容中搜索的正则表达式模式。 | | `path` | 否 | 限定搜索范围的目录路径。默认为仓库根目录。 | | `include` | 否 | 要包含在搜索中的文件 glob 模式（例如 `*.ts`、`*.{ts,tsx}`）。 | | `repo` | 否 | 要搜索的仓库名称。如果未提供，则搜索所有仓库。请使用包含托管平台的完整名称（例如 `github.com/org/repo`）。 | | `ref` | 否 | 要搜索的提交 SHA、分支或标签名称。如果未提供，则默认使用默认分支。 | | `limit` | 否 | 返回的最大匹配文件数（默认：100）。 | ### `list_repos` 列出 Sourcebot 已索引的仓库，支持可选的筛选和分页。 参数： | 名称 | 必填 | 描述 | |---|---|---| | `query` | 否 | 按名称筛选仓库（不区分大小写）。 | | `page` | 否 | 分页页码（最小 1，默认：1）。 | | `perPage` | 否 | 每页分页结果数（最小 1，最大 100，默认：30）。 | | `sort` | 否 | 按 'name'（名称）或 'pushed'（最近提交）排序仓库。默认：'name'。 | | `direction` | 否 | 排序方向：'asc'（升序）或 'desc'（降序）（默认：'asc'）。 | ### `read_file` 读取指定文件的源代码，支持对大文件进行行范围控制。 参数： | 名称 | 必填 | 描述 | |---|---|---| | `repo` | 是 | 仓库名称。 | | `path` | 是 | 文件路径。 | | `ref` | 否 | 要获取源代码的提交 SHA、分支或标签名称。如果未提供，则使用默认分支。 | | `offset` | 否 | 开始读取的行号（从 1 开始计数）。省略则从文件开头开始。 | | `limit` | 否 | 最多读取的行数（最大：500）。省略则最多读取 500 行。 | ### `list_tree` 列出仓库路径下的文件和目录。每一级目录都会显示在文件之前。 参数： | 名称 | 必填 | 描述 | |---|---|---| | `repo` | 是 | 要列出文件的仓库名称。 | | `path` | 否 | 目录路径（相对于仓库根目录）。如果省略，则使用仓库根目录。 | | `ref` | 否 | 要列出文件的提交 SHA、分支或标签名称。如果未提供，则使用默认分支。 | | `depth` | 否 | 在 `path` 下方遍历的目录层级数（最小 1，最大 10，默认：1）。 | | `includeFiles` | 否 | 是否在输出中包含文件条目（默认：true）。 | | `includeDirectories` | 否 | 是否在输出中包含目录条目（默认：true）。 | | `maxEntries` | 否 | 截断前返回的最大条目数（最小 1，最大 10000，默认：1000）。 | ### `list_commits` 获取指定仓库的提交列表。 参数： | 名称 | 必填 | 描述 | |---|---|---| | `repo` | 是 | 要列出提交的仓库名称。 | | `query` | 否 | 搜索查询，用于按提交消息内容筛选（不区分大小写）。 | | `since` | 否 | 显示晚于此日期的提交。支持 ISO 8601（例如 '2024-01-01'）或相对格式（例如 '30 days ago'）。 | | `until` | 否 | 显示早于此日期的提交。支持 ISO 8601（例如 '2024-12-31'）或相对格式（例如 'yesterday'）。 | | `author` | 否 | 按作者姓名或邮箱筛选提交（不区分大小写）。 | | `ref` | 否 | 要列出提交的提交 SHA、分支或标签名称。如果未提供，则使用默认分支。 | | `page` | 否 | 分页页码（最小 1，默认：1）。 | | `perPage` | 否 | 每页分页结果数（最小 1，最大 100，默认：50）。 | ### `glob` 在多个仓库中查找路径匹配 glob 模式的文件（例如 `**/*.ts`、`src/**/*.test.{ts,tsx}`）。结果按仓库分组。 参数： | 名称 | 必填 | 描述 | |---|---|---| | `pattern` | 是 | 用于匹配文件路径的 glob 模式（例如 `**/*.ts`、`src/**/*.test.{ts,tsx}`）。 | | `path` | 否 | 将结果限制在此子目录下的文件。 | | `repo` | 否 | 要搜索的仓库名称。如果未提供，则搜索所有仓库。请使用包含托管平台的完整名称（例如 `github.com/org/repo`）。 | | `ref` | 否 | 要搜索的提交 SHA、分支或标签名称。如果未提供，则默认使用默认分支。 | | `limit` | 否 | 返回的最大文件数（默认：100）。 | ### `find_symbol_definitions` 查找符号（函数、类、变量等）在仓库中的定义位置。 参数： | 名称 | 必填 | 描述 | |---|---|---| | `symbol` | 是 | 要查找定义的符号名称。 | | `repo` | 是 | 要限定搜索范围的仓库名称。请使用包含托管平台的完整名称