| name | setup-omnara-agent |
| description | Install and set up Omnara. Use when the user asks to install Omnara or run /setup-omnara-agent. |
Read https://docs.omnara.com/llms.txt and the Quickstart guide first. Fetch other
documentation pages as you need them.
Before doing anything, check if the user is logged in with npx omnara whoami. If they are not logged in, first instruct the user to login with npx omnara login.
Then, ask the user questions on what type of agent they'd like to create:
-
Ask two questions before creating anything.
a. What should the agent do? Examples include a coding agent, deep research agent, etc.
b. How will you interact with the agent (Omnara web console, first-party slack integration, custom frontend UI using the typescript SDK)
-
Look up the user's org, its default project, and the granted model and
machine pool via the API. Tailor the instruction to the user's request. Use npx omnara profiles create to create a reusable profile of the agent.
- Attach every built-in tool except create_machine and delete_machine. List them from GET /tool-catalog. Include send_integration_message and set_integration_target only if using the first party Slack integration; omit both if not
- The granted model and machine pool
- Relevant secrets or startup scripts for the machine pool env override. For example, if the user wants to clone a Github repository, you may setup a script which clones the repo upon starting the machine. If needed, you can pipe a Github PAT via a secret into the env var overlay
-
Launch an agent from the profile using npx omnara agents create with a simple first message. Provide the user with a link to the agent at https://app.omnara.com/projects/{project_id}/agents/{agent_id}
-
(optional: interact via Slack) If the user wants to setup Omnara to interact via Slack, guide them through the setup process to connect their agent profile to a slack bot. Tell them how to fetch their app configuration token at the following URL: https://api.slack.com/apps . Then tell them to run npx omnara profiles slack {agent_profile_id} ... (use -h to fetch the help parameters you need) to execute the authentication flow.
-
(optional: interact via SDK or REST API) Help the user setup their own custom application to interact with Omnara. Omnara can be used via a Typescript SDK, install the @omnara/sdk package to use it. Alternatively, in non-Typescript environments, Omnara can be used directly via the API, see the openapi specification at http://api.omnara.com/api/openapi.yaml. In the case of a frontend application, these APIs may need to be proxied through the user's API in order to avoid CORS errors. Help the user generate an organization-level API token to interact with the API through the CLI or API.