Prompts do sistema

Os prompts do sistema permitem restringir o comportamento do agente, adicionar contexto específico do domínio ou definir o tom e o estilo das respostas.

Por padrão, o SDK usa um prompt interno do sistema que fornece ao agente os principais recursos, incluindo edição de arquivos, pesquisa de código e acesso ao shell. Você pode substituir totalmente esse prompt ou anexar instruções adicionais a ele.

Substituir o prompt padrão

Passe uma cadeia de caracteres para a opção systemPrompt para substituir totalmente o prompt interno do sistema. Siga esse procedimento quando precisar de controle total sobre o comportamento do agente e não quiser nenhuma das instruções padrão.

import { createCortexCodeSession } from "cortex-code-agent-sdk";

const session = await createCortexCodeSession({
  cwd: process.cwd(),
  systemPrompt: `You are a code review assistant.
Prioritize finding bugs, security issues, and maintainability risks.
Explain the issue and suggest concrete fixes.`,
});

Aviso

Substituir o prompt padrão remove todas as instruções internas, incluindo orientações de uso de ferramentas e proteções de segurança. Substitua o prompt somente quando precisar de controle completo sobre o comportamento do agente.

Anexar ao prompt padrão

Para manter os recursos internos ao adicionar suas próprias instruções, use um objeto predefinido de prompt do sistema com o campo append. O nome predefinido está implícito, logo você só precisa de {"type": "preset", "append": ...}. Isso adiciona suas instruções após o prompt padrão do sistema.

import { createCortexCodeSession } from "cortex-code-agent-sdk";

const session = await createCortexCodeSession({
  cwd: process.cwd(),
  systemPrompt: {
    type: "preset",
    append: "Focus on Python files. Always run pytest after making changes.",
  },
});

Ambos os SDKs também fornecem uma abreviação apenas para anexo:

import { createCortexCodeSession } from "cortex-code-agent-sdk";

const session = await createCortexCodeSession({
  cwd: process.cwd(),
  appendSystemPrompt: "Focus on Python files. Always run pytest after making changes.",
});

Padrões comuns

Revisor de código com foco em revisão

Direciona o agente para o comportamento de revisão de código com foco na análise:

import { createCortexCodeSession } from "cortex-code-agent-sdk";

const session = await createCortexCodeSession({
  cwd: process.cwd(),
  appendSystemPrompt: `You are a code reviewer. Follow these rules:
- Prioritize reading code and analyzing behavior before proposing changes.
- Do not modify files unless the user explicitly asks for an implementation.
- Identify bugs, security issues, and style problems.
- Provide specific line numbers and suggested fixes in your response.`,
});

Especialista específico do domínio

Coloca o foco do agente em uma tecnologia ou um domínio específico:

import { createCortexCodeSession } from "cortex-code-agent-sdk";

const session = await createCortexCodeSession({
  cwd: process.cwd(),
  appendSystemPrompt: `You are a SQL and database specialist working with Snowflake.
- Write efficient SQL queries optimized for Snowflake's columnar storage.
- Use Snowflake-specific features like VARIANT columns and FLATTEN.
- Always include LIMIT clauses in exploratory queries.
- Validate SQL syntax before suggesting changes.`,
});

Aplicador de estilo

Garanta que o agente siga padrões de codificação específicos:

import { createCortexCodeSession } from "cortex-code-agent-sdk";

const session = await createCortexCodeSession({
  cwd: process.cwd(),
  appendSystemPrompt: `Enforce these coding standards in all changes:
- Use TypeScript strict mode conventions.
- Prefer const over let; never use var.
- All functions must have explicit return types.
- Use async/await instead of raw Promises.
- Run "npm run lint" after every file change.`,
});

Práticas recomendadas

Quando anexar ou substituir

Anexar ao prompt padrão

Substituir o prompt padrão

Você deseja adicionar contexto ou restrições de domínio

Você precisa de controle completo sobre o comportamento do agente

Você deseja manter a orientação de uso de ferramenta interna

Você está criando um agente altamente especializado

Você deseja manter as proteções de segurança

As instruções padrão entram em conflito com o seu caso de uso