> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coralos.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# [agent]

> General agent information

## agent.name

<Badge color="red">required</Badge>

A [string](https://toml.io/en/v1.1.0#string) defining the name for the agent.

```toml theme={null}
[agent]
name = "my-agent"
```

**Requirements**

* At least one character
* No more than 32 characters
* Must start with a lowercase alphanumeric character
* All characters must be alphanumeric or `-`

## agent.version

<Badge color="red">required</Badge>

A [string](https://toml.io/en/v1.1.0#string) defining the version of the agent.

```toml theme={null}
[agent]
version = "1.0.0"
```

**Requirements**

* At least one character
* No more than 32 characters
* Must be a valid [semantic version](https://semver.org/)

## agent.description

<Badge color="red">required</Badge>

A [PotentialStringReference](/reference/types/potential-string-reference) description for this agent.  This
description is exclusively used by LLMs.  This description is only a default and may be overridden at runtime.  Agent
descriptions are provided to agents in the state resource.

```toml theme={null}
[agent]
description = "An agent with web search capabilities"
```

**Requirements**

* At least one character
* No more than 1024 characters

## agent.capabilities

<Badge color="blue">optional</Badge>

An [array](https://toml.io/en/v1.1.0#array) of capabilities.

```toml theme={null}
[agent]
capabilities = ["resources", "tool_refreshing"]
```

This is a placeholder field.  Currently, this has no use.

**Requirements**

* All entries must be one of the following:
  * `resources`
  * `tool_refreshing`
* Must not contain duplicates

## agent.readme

<Badge color="red">required</Badge>

A [PotentialStringReference](/reference/types/potential-string-reference) readme for this agent.  This readme
is displayed in the Coral marketplace and in Coral console.  The summary is not provided in the state resource.  In
Coral console and in Coral marketplace the readme supports markdown.

```toml theme={null}
[agent]
readme = """
A long descriptive readme for my agent.
"""
```

**Requirements**

* At least one character
* No more than 4096 characters

## agent.summary

<Badge color="red">required</Badge>

A [PotentialStringReference](/reference/types/potential-string-reference) summary for this agent.  This summary
is displayed in the Coral marketplace and in Coral console.  The summary is not provided in the state resource.

```toml theme={null}
[agent]
summary = "An agent with web search capabilities"
```

**Requirements**

* At least one character
* No more than 256 characters

## agent.license

<Badge color="red">required</Badge>

The license for this agent.  Licenses may be specified as an [SPDX expression](https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions/)
or text via the [PotentialStringReference](/reference/types/potential-string-reference) type.

The license will be displayed in the Coral marketplace.

<Tabs>
  <Tab title="SPDX">
    ```toml theme={null}
    [agent.license]
    type = "spdx"
    expression = "MIT"
    ```

    **Requirements**

    * The expression must be valid.  See [here](https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions)
      for more information.
  </Tab>

  <Tab title="Text">
    ```toml theme={null}
    [agent.license]
    type = "text"
    text = { type = "file", path = "LICENSE.TXT" }
    ```

    **Requirements**

    * The license text must not be larger than 2 MiB
  </Tab>
</Tabs>

## agent.keywords

<Badge color="blue">optional</Badge>

An [array](https://toml.io/en/v1.1.0#array) of [string](https://toml.io/en/v1.1.0#string) keywords to describe this
agent.  These keywords are used by the Coral marketplace and the Coral console agent registry to search for agents.

```toml theme={null}
[agent]
keywords = ["web", "search"]
```

**Requirements**

* Each keyword must contain at least one character
* Each keyword must not contain more than 256 characters
* Must not contain duplicates
* Must not contain more than 64 keywords

## agent.links

<Badge color="blue">optional</Badge>

A [table](https://toml.io/en/v1.1.0#table) of [strings](https://toml.io/en/v1.1.0#string), where the key is the
link name and the value is the link URL.  These links are displayed in the Coral marketplace and in the Coral console.

```toml theme={null}
[agent]
links.github = "https://github.com/coral-Protocol/coral-server"
links.home = "https://www.coralos.ai"
```

**Requirements**

* Link names must start with an alphabetic character
* Link names must contain only alphanumeric characters, underscores (`_`) and dashes (`-`)
* Link names must be at least one character long and at most 32 characters long
* Link values must be at least one character long and at most 256 characters long
* Link values must be a valid URL
* Link values must be either `https`, `mailto` or `tel`
* No more than 16 links may be specified