Eventum Logo

Eventum

Tools & resources

Every tool the agent can call, every resource it can read, and the guided prompts it can run.

This page lists everything the agent can use: the tools it calls to take action, the resources it reads to ground itself, and the prompts that guide it through common tasks.

In the tool tables, the Access column marks each tool Read or Write. Write tools change files or control generators, and are gated: over HTTP they require server.mcp.allow_write, and over stdio they are available unless you pass --read-only.

Discovery tools

Read-only, and available on both transports. They let the agent learn what Eventum offers before it writes a config.

ToolDescription
list_pluginsList the available input, event, and output plugins.
get_plugin_schemaReturn the configuration schema for one plugin.
list_formattersList the available output formatters.
get_formatter_schemaReturn the configuration schema for one formatter.
describe_sampleDescribe a CSV or JSON sample file used by a generator.
list_secret_namesList the secret names in the keyring, so a config can reference them. The agent cannot read or change their values — that is done with eventum-keyring.
list_secret_referencesList the projects whose configuration reads a given secret, to see what a rename or a removal would break.

Workspace & authoring tools

Available on both transports. They operate on the generators in your generators directory.

ToolAccessDescription
list_generatorsReadList the saved generators.
list_generator_filesReadList the files in one generator.
read_generator_fileReadRead a file in a generator. A file larger than the read limit comes back in windows the agent pages through, so a generator output file cannot flood its context.
write_generator_fileWriteCreate or overwrite a file in a generator.
delete_generator_fileWriteDelete a file from a generator.
delete_generatorWriteDelete a whole generator and its files.
validate_generatorReadValidate a generator and return any errors.
preview_timestampsReadPreview the timestamps a generator would produce.
preview_eventsReadPreview the events a generator would produce.
run_generatorWriteRun a saved generator once to its configured outputs, stopping when it finishes or reaches a time or event limit.

validate_generator and the preview_* tools load the generator into the same pipeline a real run uses, so the agent sees exactly what a run would produce. See how it works.

Live-management tools

Available only over HTTP. They control the generators the server manages, and rename the objects an instance holds.

ToolAccessDescription
list_generators_liveReadList the generators the server manages, with their status.
get_generator_statusReadReturn the current status of one managed generator.
get_generator_statsReadReturn runtime statistics for one running generator.
start_generatorWriteStart a managed generator.
stop_generatorWriteStop a managed generator.
register_generatorWriteRegister an authored generator with the running server, so it can be started and is restored after a server restart.
unregister_generatorWriteRemove a generator from the running server, and stop restoring it on restart.
rename_generatorWriteRename a stopped generator, keeping its project, parameters and scenario membership.
get_generator_logsReadReturn the recent log lines for a managed generator, to diagnose a run.
list_startup_generatorsReadList the generators configured to start with the server.
rename_generator_configWriteRename a project, moving its directory and repointing the generators that use it. All of them must be stopped first.
rename_secretWriteRename a secret, keeping its value under the new name. Configurations are not rewritten — check list_secret_references first.

Scenario tools

Available only over HTTP. A scenario is a named group of generators — a tag on their startup entries — used to operate related generators together.

ToolAccessDescription
list_scenariosReadList the defined scenarios.
get_scenarioReadReturn a scenario and the ids of the generators in it.
add_generator_to_scenarioWriteAdd a generator to a scenario.
remove_generator_from_scenarioWriteRemove a generator from a scenario.
rename_scenarioWriteRename a scenario, rewriting the tag on every generator in it.
delete_scenarioWriteDelete a scenario, untagging every generator in it.

Global-state tools

Available only over HTTP. Generators coordinate at runtime through a shared global state; these tools read and edit it. The values are runtime data written by templates and are returned as-is.

ToolAccessDescription
get_global_stateReadReturn the whole shared global state.
get_global_state_keyReadReturn one value from the global state.
set_global_stateWriteSet one or more keys in the global state.
delete_global_state_keyWriteRemove one key from the global state.
clear_global_stateWriteRemove every key from the global state.

Instance tools

Available only over HTTP. They read and control the running instance itself.

ToolAccessDescription
update_settingsWritePatch the instance settings file. Auth credentials cannot be changed, and the change applies on the next restart.
stop_instanceWriteStop the instance.
restart_instanceWriteRestart the instance, applying any pending settings change.

The MCP server runs inside the instance, so stop_instance and restart_instance end the agent's own connection — the call returns as the server goes down.

Resources

Documents the agent reads to ground itself. Read-only, on both transports.

ResourceDescription
eventum://templating/referenceThe in-template API the template plugin exposes, always current with the installed version.
eventum://schema/generatorThe JSON Schema of the top-level generator.yml document.
eventum://examples/generatorsBundled, validated worked examples to start from, plus links to the public content-packs repository and the generator hub.
eventum://workspace/configsThe generators currently saved in your generators directory.
eventum://instance/infoVersion, runtime, and host metrics of the running instance. HTTP only.
eventum://instance/settingsThe running instance settings, with auth credentials redacted and absolute paths reduced to file names. HTTP only.

Prompts

Ready-made task guides the agent can invoke.

PromptDescription
create_generatorGuide the agent through the full authoring loop.
live_opsOperate the generators on a running server. HTTP only.

On this page