Skip to content

Creating an Agent Record

Follow the steps below to ensure that your agent record is complete and compliant. The model provides a structured way to describe your record's features, capabilities, and dependencies.

Basic Information

Start by filling out the basic metadata of your record:

  • name: Provide a descriptive name for your record.
  • description: Provide a description for your record.
  • version: Use semantic versioning to indicate the current version of your record.
  • schema_version: Provide the OASF schema version the record needs to be valid against. Must be in semantic versioning format (see https://semver.org/), e.g., "0.7.0".
  • authors: List the authors in the Name <email> format. Replace Your Name and you@example.com with the appropriate details.
  • created_at: Use RFC 3339 format to specify when the record was created.

Define Skills

The skills section outlines the capabilities of the agent record. Retrieve skill definitions from the OASF skills catalog. Each skill must include the following:

  • name: The name as a unique identifier (including the skill hierarchy) of a specific skill or capability (for example, natural_language_processing/natural_language_generation/text_completion).
  • id: The unique identifier for the skill class.

You can add multiple skills to your record.

Define Domains

The domains section outlines the domains in which your agent record excels. Retrieve domain definitions from the OASF domains catalog. Each domain must include the following:

  • name: The name as a unique identifier (including the domain hierarchy) of a specific domain (for example, technology/network_operations).
  • id: The unique identifier for the domain class.

You can add multiple domains to your agent.

Add Locators

The locators section provides references to the agent's source code or other resources. If the agent is packaged as a Docker container, provide the corresponding image or registry URL.

You can also provide the source code:

{
  "type": "source_code",
  "url": "https://github.com/agntcy/csit/tree/main/samples/crewai/simple_crew"
}

Specify Modules

The modules section is critical for describing the features and operational parameters of your record. To ensure compatibility, you must select extensions from the OASF modules catalog.

Validate and Finalize

Double-check that all fields are filled out accurately. Ensure that extensions and skills are selected from the OASF schema to maintain compatibility. Use the Draft-07 schema of the record or the validation endpoint of OASF to validate your record. Test the agent's configuration to verify that it works as expected.