Skip to Content
ReferênciaSchema de Configuração

Schema de Configuração

Referência completa de todos os arquivos de configuração, variáveis de ambiente e schemas do SpecForge.

O SpecForge usa três camadas de configuração: configurações globais de usuário, configurações por projeto e configuração do servidor MCP.

Precedência de Configuração

Quando a mesma configuração existe em múltiplos níveis, o valor mais específico vence:

Variável de ambiente (mais alta) Config do projeto .specforge/config.json Config global ~/.specforge/config.json Padrões embutidos (mais baixa)

✅ Execute specforge configure sem argumentos para ver a configuração totalmente resolvida, mostrando quais valores vêm de qual fonte.

Configuração Global

Localização: ~/.specforge/config.json

Criada por specforge login e gerenciada com specforge configure. Aplica-se a todos os projetos a menos que sobrescrita por configurações de nível de projeto.

{ "apiKey": "sf_live_your_key_here", "format": "text", "defaultProjectId": "proj_abc123" }
CampoTipoPadrãoDescrição
apiKeystringSua chave de API do SpecForge. Definida automaticamente por specforge login.
format"text" | "json""text"Formato de output padrão para comandos da CLI.
defaultProjectIdstringID do projeto usado quando nenhum contexto de projeto está disponível.

ℹ️ A configuração global é específica do usuário e não deve ser commitada no controle de versão. Ela é armazenada no seu diretório home.

Configuração do Projeto

Localização: .specforge/config.json (relativo à raiz do seu repositório)

Criada por specforge init. Contém configurações específicas do projeto que tipicamente são commitadas no controle de versão e compartilhadas com a equipe.

{ "projectId": "proj_abc123", "specificationId": "spec_xyz789", "mcpOutputFormat": "toon", "autoSetContext": true, "agentTeams": { "enabled": false, "strategy": "auto", "maxTicketsPerTeam": 10, "maxParallelEpics": 3, "branchPrefix": "ticket/" } }
CampoTipoPadrãoDescrição
projectIdstringO projeto SpecForge ao qual este repositório está vinculado.
specificationIdstringA especificação atualmente ativa.
mcpOutputFormat"toon" | "json""toon"Codificação de resposta MCP local para este projeto.
autoSetContextbooleantrueDefinir automaticamente contexto de projeto e especificação ao executar ferramentas MCP.
agentTeamsobjectConfiguração para implementação autônoma com Agent Teams.

Configuração de Agent Teams

O objeto agentTeams dentro da configuração do projeto controla como equipes autônomas de agentes executam contra sua especificação.

{ "agentTeams": { "enabled": false, "strategy": "auto", "maxTicketsPerTeam": 10, "maxParallelEpics": 3, "branchPrefix": "ticket/" } }
CampoTipoPadrãoDescrição
enabledbooleanfalseSe o modo Agent Teams está ativo para este projeto.
strategy"auto" | "single" | "parallel" | "phased""auto"Quanto do grafo de dependências roda concorrentemente. auto deixa o orquestrador escolher com base no formato do DAG. single roda um worker por vez. parallel roda épicos independentes concorrentemente. phased roda o DAG em fases ordenadas por dependência.
maxTicketsPerTeamnumber10Máximo de tickets (work sessions) atribuídos a uma única equipe de épico (1–20).
maxParallelEpicsnumber3Máximo de equipes de épico rodando em paralelo (1–10).
branchPrefixstring"ticket/"Prefixo de branch git para branches criadas por agentes. Cada ticket recebe uma branch como ticket/tkt-abc123.

⚠️ Agent Teams requer um servidor MCP propriamente configurado e quota de API suficiente. Execute specforge doctor para verificar antes de habilitar.

Configuração do Servidor MCP

Localização: .mcp.json (na raiz do seu repositório)

Gerado por specforge init ou specforge scaffold. Diz ao seu agente de código como se conectar ao servidor MCP do SpecForge.

{ "mcpServers": { "specforge": { "command": "npx", "args": ["-y", "@specforge/cli", "mcp"], "env": { "SPECFORGE_API_KEY": "sf_live_your_key_here" } } } }

O objeto mcpServers segue o formato padrão de configuração MCP. A chave "specforge" é o nome do servidor visível para seu agente de código. Os campos command e args iniciam o processo do servidor MCP do SpecForge.

✅ Se você autenticou com specforge login, pode omitir o campo env.SPECFORGE_API_KEY. O servidor MCP lê credenciais da sua configuração global automaticamente.

Variáveis de Ambiente

VariávelDescriçãoPrecedência
SPECFORGE_API_KEYChave de API para autenticaçãoSobrescreve apiKey em todos os arquivos de config

A variável de ambiente tem a precedência mais alta. Quando definida, sobrescreve qualquer chave de API configurada em arquivos de configuração global ou de projeto. Esta é a abordagem recomendada para ambientes de CI/CD.

export SPECFORGE_API_KEY="sf_live_your_key_here"

Configuração de Padrões de Qualidade

Configurações de gates de qualidade — os thresholds de prontidão por camada e os gates de implementação {acceptance, step, file, test} — são configurações do validator no nível do projeto, não chaves do configure (o configure aceita apenas as cinco chaves planas acima). Elas são gerenciadas pelo painel.

Para a referência completa com todos os campos, padrões e perfis, veja Padrões de Qualidade.

Arquivos de Configuração de Agente

Gerados por specforge init ou specforge scaffold. Veja Integrações para detalhes sobre o que cada arquivo contém e como agentes os usam.

ArquivoGerado ParaPropósito
CLAUDE.mdClaude CodeÂncora de contexto do projeto
.claude/skills/Claude CodeSkills operacionais para uso de ferramentas MCP
.claude/agents/Claude CodeDefinições de agente para Agent Teams
GEMINI.mdGemini CLIInstruções de agente
AGENTS.mdCodex CLI, OpenCode, outrosInstruções universais de agente
.gemini/settings.jsonGemini CLIConfiguração MCP
.codex/config.tomlCodex CLIConfiguração MCP
opencode.jsonOpenCodeConfiguração MCP

Veja Também