site/docs/integrations/agent-skill.md
AI coding agents can write promptfoo configs, but they often get the details wrong: shell-style env vars that do not work, hallucination rubrics that cannot see the source material, tests dumped inline instead of in files, and red-team configs that collapse real app inputs into one generic prompt field. The portable promptfoo-evals skill covers eval conventions, while the Codex promptfoo-redteam-setup and promptfoo-redteam-run skills cover red-team setup and scan triage.
If you use Codex, prefer the Codex plugin bundle when you want the full workflow:
eval authoring, provider setup, red-team setup, and scan triage. Use the
portable single promptfoo-evals skill when you intentionally want an eval-only
skill that also works in other compatible tools.
The portable skill works with Claude Code and OpenAI Codex. It follows the open Agent Skills standard, so it should also work with other compatible tools.
Without the skill, agents frequently:
$ENV_VAR syntax in YAML configs, which does not work because promptfoo uses Nunjucks '{{env.VAR}}'llm-rubric assertions that reference "the article" but don't inline the source, so the grader can't actually comparefile://tests/*.yamlllm-rubric when contains or is-json would be faster, free, and deterministicThe skill gives the agent these rules up front.
The Codex red-team skills cover a different set of common mistakes: flattening multi-input targets into one prompt field, choosing broad scans before mapping the app boundary, and regenerating probes when a stable rerun would be easier to compare.
/plugin marketplace add promptfoo/promptfoo
/plugin install promptfoo-evals@promptfoo
For Codex, Promptfoo includes a plugin bundle at
plugins/promptfoo, exposed by .agents/plugins/marketplace.json. It contains
four skills: promptfoo-evals, promptfoo-provider-setup,
promptfoo-redteam-setup, and promptfoo-redteam-run.
| Skill | Use it for |
|---|---|
promptfoo-evals | Non-redteam eval suites, assertions, test cases, and result inspection |
promptfoo-provider-setup | HTTP targets plus JavaScript or Python file:// providers and wrappers |
promptfoo-redteam-setup | Focused redteam configs from live endpoints, OpenAPI specs, or static code |
promptfoo-redteam-run | Running generated scans, triaging failures, and filtered reruns |
There is intentionally no meta selector skill. Codex routes from each skill's description and default prompt.
Python providers are first-class in the Codex bundle. The provider and redteam
skills cover Promptfoo's file://provider.py and
file://provider.py:function_name syntax for eval providers, redteam targets,
local graders, and local redteam generators, including workers, timeout, and
PROMPTFOO_PYTHON configuration.
Use the Claude marketplace command above when you want the portable single
promptfoo-evals skill. Use the Codex bundle for the preferred Codex
experience, especially when provider setup or redteam work is part of the job.
To reuse the bundle in another Codex workspace, copy plugins/promptfoo and
its .agents/plugins/marketplace.json entry together.
For red teaming, use the Codex bundle:
promptfoo-provider-setup connects the system under test,
promptfoo-redteam-setup turns live endpoints, OpenAPI specs, or static code
into a scan plan, and promptfoo-redteam-run executes and triages the
generated probes.
Manual install below covers only the portable eval-only skill. Download the skill directory and copy it to the correct location for your tool:
Claude Code (project-level, recommended for teams):
cp -r promptfoo-evals your-project/.claude/skills/
Claude Code (personal, available in all projects):
cp -r promptfoo-evals ~/.claude/skills/
OpenAI Codex / other Agent Skills tools:
cp -r promptfoo-evals your-project/.agents/skills/
:::note
For Codex, prefer the plugin bundle above when you want the full Promptfoo
workflow. Commit the portable single skill to .agents/skills/ only when your
team intentionally wants eval-only guidance. Every developer's agent then picks
it up automatically, with no per-person install needed.
:::
The core skill consists of two files:
| File | Purpose |
|---|---|
SKILL.md | Workflow instructions the agent follows |
references/cheatsheet.md | Assertion types, provider patterns, and config examples |
Once installed, the agent activates automatically when you ask it to create or update eval coverage. In Claude Code, you can also invoke it directly with a slash command:
/promptfoo-evals Create an eval suite for my summarization prompt
In Codex and other Agent Skills tools, ask the agent to create an eval. The skill activates from the task context.
For red-team work in Codex, ask for the task directly:
Create a focused red team config for this invoice assistant. Preserve user_id, invoice_id, and message inputs; test policy, RBAC, and BOLA.
Run the generated redteam scan, summarize attack success rate, and give me the narrowest rerun command for failures.
The agent:
promptfooconfig.yaml, prompts/, tests/)promptfoo validate:::note New to promptfoo? See Getting Started for an overview of configs, providers, and assertions. :::
contains, is-json, javascript before reaching for llm-rubric. Deterministic checks are fast, free, and reproducible.tests/*.yaml files loaded via file://tests/*.yaml glob, keeping configs clean as test count grows.tests: file://tests.csv or script-generated tests like file://generate_tests.py:create_tests.llm-rubric to check for hallucination, the source material must be inlined in the rubric via {{variable}} so the grader can actually compare.defaultTest.options.provider or assertion.provider) for stable scoring.'{{env.API_KEY}}' in YAML configs, not shell syntax.promptfoo eval -o output.json --no-cache and inspect success, score, and error.The Codex bundle also teaches the agent to:
policy, rbac, bola, hijacking, prompt-extraction, and system-prompt-override from live or static evidence instead of defaulting to one broad scan.redteam eval when possible, and separate grader failures from real target failures.Ask the agent to "create an eval for a customer support chatbot that returns JSON" and it produces:
# yaml-language-server: $schema=https://promptfoo.dev/config-schema.json
description: 'Customer support chatbot'
prompts:
- file://prompts/chat.json
providers:
- id: openai:chat:gpt-4.1-mini
config:
temperature: 0
response_format:
type: json_object
defaultTest:
assert:
- type: is-json
- type: cost
threshold: 0.01
tests:
- file://tests/*.yaml
- description: 'Returns order status for valid customer'
vars:
order_id: 'ORD-1001'
customer_name: 'Alice Smith'
assert:
- type: is-json
value:
type: object
required: [status, message]
- type: javascript
value: "JSON.parse(output).status === 'shipped'"
A red-team setup should keep the security boundary visible instead of collapsing it into one free-form prompt:
description: 'Invoice assistant red team'
targets:
- id: https
label: invoice-assistant
inputs:
user_id: Signed-in user identifier.
invoice_id: Invoice being requested.
message: User message.
config:
url: '{{env.INVOICE_AGENT_URL}}'
method: POST
stateful: false
body:
user_id: '{{user_id}}'
invoice_id: '{{invoice_id}}'
message: '{{message}}'
transformResponse: json.output
redteam:
purpose: >-
Invoice assistant for signed-in users. It may answer questions about the
caller's invoices only and must not reveal or modify other users' invoices.
plugins:
- id: policy
config:
policy: The assistant must not disclose or modify another user's invoices.
- rbac
- bola
strategies:
- basic
The skill is just markdown files. Edit them to match your team's conventions: