Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Recommending Agent Extensions

There are two ways to recommend agent extensions to users:

  1. Central recommendations - submit to the Symposium recommendations registry
  2. Crate metadata - add recommendations directly in your crate’s Cargo.toml

Extension Sources

Extensions are referenced using a source field:

SourceSyntaxDescription
crates.iosource.crate = "name"Rust crate installed via cargo
ACP Registrysource.acp = "id"Extension from the ACP registry
Direct URLsource.url = "https://..."Direct link to extension.json

Central Recommendations

Submit a PR to symposium-dev/recommendations adding an entry:

[[recommendation]]
source.crate = "my-extension"
when-using-crate = "my-library"

# Or for multiple trigger crates:
[[recommendation]]
source.crate = "my-extension"
when-using-crates = ["my-library", "my-library-derive"]

This tells Symposium: “If a project depends on my-library, suggest my-extension.”

Users can also add their own local recommendation files for internal/proprietary extensions.

Crate Metadata Recommendations

If you maintain a library, you can recommend extensions directly in your Cargo.toml. Users of your crate will see these suggestions in Symposium.

Shorthand Syntax

For crates.io extensions:

[package.metadata.symposium]
recommended = ["some-extension", "another-extension"]

Full Syntax

For extensions from other sources:

# Recommend a crates.io extension
[[package.metadata.symposium.recommended]]
source.crate = "some-extension"

# Recommend an extension from the ACP registry
[[package.metadata.symposium.recommended]]
source.acp = "some-acp-extension"

# Recommend an extension from a direct URL
[[package.metadata.symposium.recommended]]
source.url = "https://example.com/extension.json"

Example

If you maintain tokio, you might add:

[package]
name = "tokio"
version = "1.0.0"

[package.metadata.symposium]
recommended = ["symposium-tokio"]

Users who depend on tokio will see “Tokio Support” suggested in their Symposium settings.