Skip to main content

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.name

required A string defining the name for the agent. 
[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

required A string defining the version of the agent. 
[agent]
version = "1.0.0"
Requirements
  • At least one character
  • No more than 32 characters
  • Must be a valid semantic version

​
agent.description

required A PotentialStringReference 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. 
[agent]
description = "An agent with web search capabilities"
Requirements
  • At least one character
  • No more than 1024 characters

​
agent.capabilities

optional An array of capabilities. 
[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

required A PotentialStringReference 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. 
[agent]
readme = """
A long descriptive readme for my agent.
"""
Requirements
  • At least one character
  • No more than 4096 characters

​
agent.summary

required A PotentialStringReference 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. 
[agent]
summary = "An agent with web search capabilities"
Requirements
  • At least one character
  • No more than 256 characters

​
agent.license

required The license for this agent. Licenses may be specified as an SPDX expression or text via the PotentialStringReference type. The license will be displayed in the Coral marketplace. 
[agent.license]
type = "spdx"
expression = "MIT"
Requirements
  • The expression must be valid. See here for more information.

​
agent.keywords

optional An array of string keywords to describe this agent. These keywords are used by the Coral marketplace and the Coral console agent registry to search for agents. 
[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
optional A table of strings, 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. 
[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