Installing an agent from a link
The fastest way to install an agent in Powerboards is from a link. When you click an install link:- Powerboards prompts you to sign in or create an account.
- You select a Project and Room to deploy the agent.
- The agent is installed into the Room and ready to use!
https://app.powerboards.com/install?url=SERVICE_TEMPLATE_SPEC_URL
If you already have an install link you can start using the agent immediately, you don’t need to write any code or use the CLI. Just click the link and follow the prompts.
The rest of this page explains how to make agents show up in Powerboards and package an agent so that it can be shared with an install link.
How agents get into Powerboards
Conversational agents (ChatBots and VoiceBots) deployed with MeshAgent can be used in Powerboards automatically. Once deployed, your agent appears in the Powerboards agents dropdown alongside the built-in defaults (assistant, voice, developer, transcriber) and users can install it into their Room. There are two ways to get agents into Powerboards:- Share your agent with anyone via install link
- Use a
ServiceTemplateYAML file hosted publicly. - Anyone can click the link and install the agent into their own Project and Room. This allows you to easily share agents at scale.
- Use a
- Deploy directly to a Room you control
- Use a
ServiceYAML file and the MeshAgent CLI. - You deploy the agent into a specific Room in a Project you own, then install it from the Powerboards UI.
ChatBot or VoiceBot, and expose a meshagent endpoint. Powerboards then makes it installable.
Prerequisites
Before sharing agents in Powerboards, you should understand:- How to package services using service definition files
- How to deploy services using the MeshAgent CLI
- The basics of room services and project services
- Docker Hub: https://hub.docker.com/r/meshagent/
- Google Artifact Registry: https://console.cloud.google.com/artifacts/docker/meshagent-public/us-central1/images
Path 1: Sharing your agent with a link
Use this path when you want anyone to be able to install your agent, even in Projects you don’t control. You will:- Write a
ServiceTemplatemanifest that describes your agent. - Host that YAML file at a URL accessible by the browser.
- Construct and share an install link that points to that URL.
1. Create a ServiceTemplate YAML
YourServiceTemplate must include:
meshagent.service.idunderannotationsin the service metadata.meshagent.agent.typeset toChatBotorVoiceBot.- A
meshagentendpoint with the appropriate identity.
yaml
2. Host the template (recommended: GitHub Gist)
The easiest way to host aServiceTemplate for Powerboards is using a GitHub Gist.
- Create a public or secret GitHub Gist (either is fine, as long as anyone with the link can read it).
- Paste your YAML.
- Name the file (for example
meshagent.yaml). - Save the gist.
- Click Raw and copy the raw file URL from the browser bar.
Raw GitHub Gist URLs already work with CORS by default, so you don’t have to configure anything. You can also use any other public URL, but if you’re hosting it yourself you’ll need to make sure:
- The YAML is publicly reachable.
- The server allows cross-origin GET requests from the Powerboards web app.
3. Construct and share the install link
Next add the link to your the raw file URL to the install part.https://app.powerboards.com/install?url=SERVICE_TEMPLATE_SPEC_URL
Where SERVICE_TEMPLATE_SPEC_URL is the URL-encoded version of your YAML file’s URL (for example, the raw Gist URL).
Now you can share the link with anyone! They will be prompted to choose a Project and Room to install their agent!
Path 2: Deploy an agent directly to your own Room
Use this path when you control the Project and Room and want to deploy an agent directly, without a public link. You will:- Write a
Servicemanifest that describes your agent. - Deploy it to a Room with the MeshAgent CLI.
- Install it from the Powerboards UI.
- Invite teammates.
1: Package your agent
Create a service definition file (meshagent.yaml) that includes:
- A
meshagent.service.idunderannotationsin themetadatasection - An
agentsentry with a validmeshagent.agent.typeannotation (eitherChatBotorVoiceBot). - Expose a
meshagentendpoint in theportssection
meshagent.yaml
2. Deploy the agent
Next deploy it to a specific room using the MeshAgent CLIbash
3. Install the agent in Powerboards
After deploying the agent, room owners can install it in Powerboards:- Go to Powerboards
- Open your Room (
myroom) - Select the Agents dropdown —> Manage Agents —> Install agent
- Choose your deployed agent and install it.
4. Invite team members
Once your agent is installed, invite people to your Room to use the agent with you:- Select the Room menu —> Permissions
- Invite users via email (they must be members of the project already or you must be a project admin to invite them)
- Invited users can instantly join the room and interact with your agents
Editable agent rules and collaboration in Powerboards
Powerboards lets Room members customize agent behavior together. The default agents (assistant, developer, voice) each have an editable rules.txt file in Room storage that users can edit to steer the agent’s behavior.
When you create your own agents and share them in Powerboards, you control if and how editable those rules are.
In the example above, we deployed a ChatBot to Powerboards using a Service YAML that points to the MeshAgent CLI image. You can pass tools and rules to the ChatBot by adding flags like --web-search and --rule to the meshagent chatbot service command.
To enable collaboration on rules, use the --room-rules flag. This will add a rules.txt file for your agent to the room so that anyone in the Room can edit the agent’s rules.
Rules options
--rule: Inline, non-editable rules baked into the service definition. Best for fixed instructions.--room-rules: Allow team members to edit the agents rules as they work with it in the Room. Passing this flag will create a path in room storage (e.g., agents/chatbot/rules.txt) that room members can edit to customize agent behavior.--rules-file: Reads a file baked into your Docker image (non-editable by room). Useful for custom images and fixed instructions.
--room-rules enables true collaboration - team members can refine the agent’s instructions during the session without redeploying the ChatBot service. Once the service is deployed (as described above) and installed in Powerboards (Agents → Manage agents → Install agent), Room members can edit the rules file (for example agents/chatbot/rules.txt) directly in Powerboards to customize the agent’s behavior.
Related topics
- Packaging services: Field reference for Service and ServiceTemplate manifests.
- Deploying services: CLI and Studio workflows for project/room deployments.
- Project service example: Deploy a chatbot as a project-wide service.
- Room services example: Deploy a room-scoped chatbot with runtime inputs.
- CLI getting started: Quickstart and CLI flags (
chatbot joinvschatbot service).