For information about project and personal configuration locations, see the Project vs Personal Config page.
firebender.json
file must be located in the project root directory for project-wide configuration, or in ~/.firebender/firebender.json
for personal configuration.
Fields
All high-level fields in the configuration are optional.ignore
Type:string[]?
Array of glob patterns for files that Firebender should not analyze without explicit permission.
Example:
mcpServers
Type:Object<string, ServerConfig>?
Configure Model Context Protocol (MCP) servers to provide custom tools for Firebender Agent.
mcpServers.{serverName}
- mcpServers.{serverName}.command:
string?
- The command to execute for the MCP server (required if url is not provided) - mcpServers.{serverName}.url:
string?
- The URL for HTTP-based MCP servers (required if command is not provided) - mcpServers.{serverName}.args:
string[]?
- Array of arguments to pass to the command - mcpServers.{serverName}.env:
Object<string, string>?
- Environment variables to set for the MCP server - mcpServers.{serverName}.headers:
Object<string, string>?
- HTTP headers for URL-based servers
mcpEnvFile
Type:string?
Optional path to a file containing environment variables for MCP servers. Can be either a full path or a relative path from the project root.
Example:
rules
Type:(string | RuleConfig)[]?
Define guidelines for Firebender to follow when generating code. Can contain both global rules (strings) and path-specific rules (objects).
- rules[i]:
string
- A rule that applies to all files - rules[i].filePathMatches:
string | string[]?
- Optional glob pattern(s) to match file paths for specific rules. Can be a single pattern or an array of patterns. - rules[i].rules:
string[]
- Array of rules to apply only to matching files - rules[i].rulesPaths:
string | string[]
- Path(s) to files containing additional rules. Can be either a single path or an array of paths. Paths can be absolute or relative to the project root.
commands
Type:CommandConfig[]?
Define custom commands that can be executed through Firebender’s interface. Commands are markdown files containing prompts or instructions for the AI.
CommandConfig
- name:
string
- The name of the command as it appears in the UI - path:
string
- Path to the command file. Supports~
expansion for home directory, absolute paths, and relative paths (relative to project root for project config,~/.firebender
for personal config)