For the complete documentation index, see llms.txt. This page is also available as Markdown.

Agent Guidelines Details

When you select a guideline, the details page opens and displays the guideline configuration, secure coding instructions, and usage information.

Prompt

The Prompt tab displays the guideline definition and the secure coding instructions provided to AI coding agents.

This tab includes:

Section
Description

Description

A summary of the vulnerability the guideline is designed to prevent.

Activation Criteria

The conditions OX evaluates in a developer's prompt to determine whether the guideline should be provided to the AI coding agent.

Instructions

Secure coding guidance that helps the AI coding agent generate code without introducing the targeted vulnerability.

Code Samples

Example implementations that demonstrate the recommended secure coding pattern.

OX provides this guidance to the AI coding agent automatically before code generation begins. Developers do not interact with the guidelines directly.

Usage

The Usage tab shows how the guideline has been used by AI coding agents.

The tab includes:

Engagement

Shows:

  • Number of activations during the past 30 days.

  • Total number of activations since the guideline was created.

  • A timeline chart showing guideline usage over time.

Last 10 Activations

Lists the most recent guideline activations, including:

Column
Description

Time Stamp

When the guideline was applied.

User

The user whose prompt triggered the guideline.

Tool

The AI coding tool that invoked the guideline.

Application

The repository or application associated with the request.

Last updated