Skip to content
Everruns Everruns

Preview the final agent shape with capabilities applied

POST
/v1/agents/preview

Returns the merged system prompt and all tools that would be available to the agent. This is useful for previewing what the agent will look like before saving.

Request Body required

Section titled “Request Body required ”

Request to preview the final agent shape with capabilities applied

object
capabilities

Capabilities to apply with per-agent configuration.

Array<object>

Per-agent capability configuration

Associates a capability with an agent, including optional per-agent configuration. The config field allows the same capability to behave differently per-agent.

object
config

Per-agent configuration for this capability (capability-specific)

ref
required

Reference to the capability ID

string
Example
[
  {
    "config": {},
    "ref": "current_time"
  },
  {
    "config": {},
    "ref": "test_math"
  }
]
mcpServers

Remote MCP servers scoped to the previewed agent.

object
key
additional properties

Session-, agent-, or harness-scoped remote MCP server configuration.

This intentionally mirrors the mcpServers object shape used by common MCP client config files while staying within Everruns’ current remote-HTTP-only support.

object
auth_mode

Authentication mode used when executing tools from this scoped server.

string
Allowed values: none api_key o_auth
headers

Additional HTTP headers sent on MCP requests.

object
key
additional properties
string
oauth_provider_id

Provider id used to resolve a user-scoped bearer token.

string | null
tool_discovery

Whether to discover tool definitions live from this server.

boolean
type

MCP transport type. Only remote HTTP is supported today.

string
Allowed values: http
url
required

URL of the remote MCP server endpoint.

string
system_prompt
required

The base system prompt (before capability additions)

string
Example
You are a helpful customer support agent.
tools

Client-side tools to include in the preview.

Array<object>
object

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Agent preview generated

Response showing the final agent shape after applying capabilities

object
system_prompt
required

The full system prompt with capability additions prepended

string
tools
required

All tool definitions from capabilities

Array<object>
object

500

Section titled “500 ”

Internal server error

Standard error response for API endpoints.

object
error
required

Error message describing what went wrong.

string