Skip to main content

API Configuration

The API is only configurable in the Enterprise version of BuildBuddy. For more information, view the API Documentation. For AI agent usage, see MCP Server docs.

Section​

api: The API section enables the BuildBuddy API over both gRPC(s) and REST HTTP(s). Optional

Options​

Optional

  • enable_api: Whether or not to enable the BuildBuddy API.

  • enable_mcp: Whether or not to expose the MCP server at /mcp. Requires enable_api: true.

  • api_key: The default API key to use for on-prem enterprise deploys with a single organization/group.

Example section​

config.yaml
api:
enable_api: true
enable_mcp: true