Skip to main content

Local agents

default empty list
A list of paths to agents on the local machine. Any agent included in this list will be available to the Coral server in the local agent registry source. Consider the following directory structure:
/path/to/agents
agent1
coral-agent.toml
agent2
coral-agent.toml
agent3
coral-agent.toml
Adding just agent1 could be done with:
[registry]
local_agents = ["/path/to/agents/agent1"]
Adding all agents (agent1, agent2 and agent3) could be done with:
[registry]
local_agents = ["/path/to/agents/*"]
Sometimes, you may want to use multiple wildcard paths, for example if you keep your agents in folders with versions:
/path/to/agents
agent1
1.0.0
coral-agent.toml
1.0.1
coral-agent.toml
agent2
1.0.0
coral-agent.toml
1.0.1
coral-agent.toml
This can be facilitated with:
[registry]
local_agents = ["/path/to/agents/*/*"]
The wildcard * is not permitted as part of a path segment, only as a full path segment.
Good
[registry]
local_agents = ["/path/to/agents/*/*"]
Bad
[registry]
local_agents = ["/path/to/agents*"]

Include Coral home agents

default true
If this is set to true, the following directories will be added to local agents:
  • ${HOME}/.coral/agents/*/*
  • ${HOME}/.coral/agents/*
  • ${HOME}/.coral/agents/locallinked/*/*
It is recommended to use this configuration option instead of manually adding the above paths to local agents.

Watch local agents

default true
If this is set to true, modifications to local agents will be automatically detected and reloaded. Detected changes include:
  • Deletion of an agent
  • Modification of an agent
  • New agents (for example, those that match a path that uses a wildcard)
It is possible due to a JVM limitation that changes to agents, especially those made programmatically, are not detected via this watch option. Consider setting local agent rescan timer to a non-zero value.

Local agent rescan timer

See here for more information on the format. If this is set to a non-zero value, the Coral server will periodically rescan the local agent registry for changes. Scanning the filesystem can be expensive, especially if the local agents list contains many paths with wildcards. Consider setting this to a high value or disabling it entirely.

Include debug agents

default true
If this is true, the Coral server debug agents will be available in the server’s local agent registry source.

Include marketplace agents

default true
If this is true, the Coral server will be able to directly use agents from the Marketplace.