Plugins

What a Plugin is

A Plugin supplies a building block Elyxis can use: processing data, connecting to a service, moving events, evaluating a condition, or accessing a secret provider. Its definition describes its configuration, supported payloads, and any declared service bindings.

Plugins are installed in the Elyxis platform catalog. You do not install them in your terminal to use the CLI. Your account needs permission to inspect the catalog, and the catalog can include Plugins that still need configuration for your Environment.

The main roles

The particular services and operations available depend on the installed catalog. A Plugin's presence is not proof that an API credential, service endpoint, or permission is ready.

Supported Beta-1 plugins

The hosted private beta supports these integrations. Other Plugins may exist in the platform catalog without being part of the supported Beta-1 offering.

Current limitation: managed stores

Managed-store integrations with external secret providers are not working yet and are not supported in Beta 1. Use an Elyxis-managed Keystore for API keys and other integration credentials.

MongoDB connection requirements

For hosted Beta 1, use a public endpoint with standard username/password credentials in its connection URI, such as mongodb://username:password@host/database. Use the connection URI supplied by your database provider, including its required TLS and connection options. Store the credential-bearing URI in a Keystore and reference it from configuration rather than pasting real credentials into the Assistant.

The database must allow connections from the Elyxis runtime. A private-network-only endpoint is outside the supported hosted Beta-1 setup.

Both MongoDB query transports are read-only. They do not insert, update, upsert, or delete documents. The NLQ transport uses the configured catalog to identify approved collections and fields; the raw-query transport reads the configured database and collection.

Complete-result retrieval is bounded. When completeResults is enabled, its maxCompleteResults limit defaults to 10,000 and cannot exceed 10,000. Exceeding the limit produces an error rather than silently returning incomplete results. Narrow the query or use pagination when appropriate.

OpenAI credentials and models

Both OpenAI-backed plugins support apiKey and model configuration. The chosen model must be supported by the installed Plugin configuration and available to the OpenAI account behind the API key. Use an Environment Setting for reusable configuration and a Keystore reference for the key.

NLQ generates a query; it does not connect to MongoDB or execute that query by itself. A compatible database transport and its connection configuration are also required. The OpenAI processing Plugin instead uses the App's task and schemas to define the work and expected result.

Discover before configuring

Ask the Assistant to inspect what exists:

List the installed plugins that could help classify support-ticket text.

Then ask about the exact Plugin you want to use:

Show the configuration requirements and supported inputs and outputs for that plugin.

Use the exact name or returned ID when more than one Plugin matches. Elyxis should resolve the actual installed definition rather than invent a Plugin or its configuration keys.

Connect a Plugin to an Environment

A Plugin may need configuration directly, or expose bindings that can be prepared as Environment Settings. Secret-backed entries use Keystore references.

For the ticket example, the model Plugin needs a compatible input and output, the approved model configuration, and a credential reference. Once those requirements are resolved, Elyxis can compose it into a Flow or reuse a compatible existing capability.

When no suitable Plugin exists

Ask your beta administrator whether the required integration is supported or can be installed. A conversational request cannot make an unavailable connector executable. Share the service and outcome you need so the team can distinguish a missing integration from missing configuration.