Frequently asked questions
This topic covers the most common questions about Boomi Companion, along with tips and tricks to help you get the most out of the plugin.
Getting started
What do I need before using Boomi Companion?
You need three things: an AI coding agent, an IDE or terminal, and a Boomi platform account.
On the Boomi side, you need your platform username, an API token, and your account ID. Optionally, you can provide an environment ID and runtime ID if you want Boomi Companion to deploy and test your integrations.
How do I install the Boomi Companion plugin?
Launch Claude Code and run /plugin marketplace add OfficialBoomi/boomi-companion to add the Boomi Companion marketplace. Then run /plugin, navigate to Marketplaces, select boomi-companion, select Browse plugins, and install bc-integration. Run /reload-plugins to load it. You can enable auto-updates through the same /plugin menu so you always have the latest version.
What is the difference between the template workspace and a project folder?
The template workspace is your reusable starting point; it holds your platform credentials, directory structure, and any custom instructions you have configured. A project folder is a fresh copy of that template for a specific piece of work. Each time you start a new effort, create a new project folder and run /freshies to initialize it from your template. This keeps projects isolated while letting you maintain a single source of truth for credentials and preferences.
How do I update the Boomi Companion plugin?
If you enable auto-updates during installation, the plugin updates automatically. You can also manually check for updates through the /plugin menu by navigating to Marketplaces and selecting boomi-companion.
General
What can Boomi Companion do?
With the Boomi Companion plugins/skills installed, ask your AI agent, "What are bc-integration's capabilities?". It can describe its current capabilities directly.
What does Boomi Companion not support yet?
Boomi Companion currently covers integration processes, including tech connectors, maps, scripts, profiles, EDI, and Event Streams. Platform services outside of integration, such as Flow, Data Hub, API Management, and Agentstudio, are not yet supported.
When Boomi Companion cannot build something directly, you can complete that step in the Boomi platform UI and then provide Boomi Companion with the component ID or a link. From there, it can pull the component in and continue building.
Does Boomi Companion replace the Boomi platform UI?
No. Boomi Companion is complementary tooling, not a replacement for the platform. It creates and manages components through the Platform API, but you can always view, verify, and manually edit anything it builds in the Boomi UI. Many developers use both side by side.
Can I use Boomi Companion with AI tools other than Claude Code?
Yes. Boomi Companion runs on Agent Skills, an open standard that works with multiple AI agents, including OpenAI Codex and Google Gemini. The plugin distribution adds quality-of-life conveniences in the Claude ecosystem, but the standalone boomi-integration and boomi-marketplace skills are portable to any agent that supports the standard.
Capabilities and scope
Can Boomi Companion modify components that were built in the UI?
Yes. You can reference any existing component from the platform using its component ID or URL, and Boomi Companion will pull the component along with its dependencies into your project folder. From there, you can ask Boomi Companion to modify, extend, or analyze it.
Does Boomi Companion support EDI and B2B trading partners?
Yes. EDI and B2B are in scope for the boomi-integration skill. Boomi Companion can create trading partner components, EDI profiles, and processes.
Can Boomi Companion build APIs and web service listeners?
Yes. Boomi Companion can convert existing processes into API endpoints using the Web Services Server (WSS) pattern, or build new listener-based processes from scratch. It handles the wrapper/subprocess pattern, operation configuration, and deployment.
Can Boomi Companion help me debug a failing process?
Yes. If you have configured an environment and runtime, Boomi Companion can query execution records, download execution logs, analyze errors, and suggest fixes. You can also point it at a failing process and ask it to troubleshoot; it will pull the process, review the logic, check for known error patterns, and propose changes.
Security
How should I handle Boomi integrations' connection credentials?
We recommend configuring the connection credentials directly in the Boomi platform UI and then letting Boomi Companion reference those connections by ID, without needing visibility into the credentials themselves. This keeps sensitive values, such as passwords, API keys, and OAuth tokens, out of your local workspace entirely. To make this workflow easy, your template workspace includes a preferred_connections.md file where you can list the existing connections you want Boomi Companion to reuse. During a build, Boomi Companion checks this file first and pulls the referenced connections from the platform instead of creating new ones.
How are credentials handled?
Boomi has made efforts to ensure that AI agents operating this skill do not have direct access to plaintext credentials in the context window. However, you may wish to take additional safeguards.
What credentials does Boomi Companion need?
Boomi Companion requires your Boomi platform username, a Platform API token, and your account ID. Optionally, you can configure an environment ID and runtime ID for deployment and testing.
Does my data leave my machine?
Boomi Companion is a skill for use by AI agents and exchanges data with your AI provider as part of its operation.
Cost
Does Boomi Companion have a separate cost?
No. The Boomi Companion plugin and its skills are free. The only cost is your AI agent usage, and your Boomi Platform consumption. There are no surcharges for using the Platform API that Boomi Companion uses.
Collaboration and customization
Can I customize Boomi Companion's behavior for my team?
Yes. Your template workspace includes a CLAUDE.md file where you can add custom instructions, preferences, and conventions. These persist across plugin updates and are copied into every new project you initialize. For example, you can specify naming conventions, preferred connector patterns, default error handling approaches, or any other team-specific standards.
Is Boomi Companion open-source?
Yes. Boomi Companion is published on GitHub under the BSD-2-Clause license, so you can read the source, fork it, and modify it for your own use. As a matter of project policy, the official distribution is curated by Boomi; we do not currently accept pull requests against the canonical repository. Bugs and feature ideas are welcome through the project's intake channel, where the Boomi team evaluates them for inclusion in future releases.
Troubleshooting
Boomi Companion keeps trying to do something in the GUI - what do I do?
Some operations genuinely require the GUI: OAuth authorization flows, branded connector metadata import (such as Salesforce or NetSuite), and certain discovery-based configurations. When Boomi Companion tells you something needs to be done in the GUI, it is flagging a real platform limitation. Complete the step in the UI, then return to Boomi Companion to continue building.
My process deployed but is not working - how do I debug it?
Ask Boomi Companion to check the execution logs. It can query recent executions, download logs, and analyze what went wrong. Common issues include subprocess changes not picked up by the parent (redeploy the parent), environment variable references in XML (Boomi does not support ${ENV_VAR} syntax in component XML), and Message shape quote escaping in JSON payloads. Boomi Companion knows these patterns and will check for them.
Boomi Companion made a mistake - how do I undo what it built?
Everything Boomi Companion creates is a standard Boomi component on the platform. You can delete or modify any component through the Boomi UI just as you would with anything built manually. Locally, your project folder contains the XML files Boomi Companion generated; you can ask Boomi Companion to revert a change, or delete the local files and re-pull from the platform if needed. Nothing Boomi Companion does is irreversible.
Tips and tricks
How do I get the best results?
Give Boomi Companion enough context to work with; consider whether you would have enough information to complete the task yourself if someone handed you the same prompt. Provide environment and runtime credentials in your .env file so it can test its own work. If it starts going in the wrong direction, interrupt and redirect rather than letting it continue.
Should I use Plan mode?
For complex builds, yes. Entering Plan mode (Shift+Tab twice) lets Boomi Companion think through its approach before building. This is especially useful for multi-component processes or unfamiliar use cases.
Do not clear context after Boomi Companion makes a plan; let it carry that thinking into execution.
How should I organize my work?
Create a separate project folder for each work effort and initialize it with /freshies. This keeps your template workspace reusable and your projects isolated from each other. You can customize your template workspace with personal instructions and preferences that persist across plugin updates.
Can I run multiple Boomi Companion sessions at once?
Yes. Tools such as tmux let you run multiple terminal sessions in parallel. Boomi Companion also works with Claude Code on the web, the desktop app, and claude.ai.
What if Boomi Companion does something unexpected?
Ask it to explain why it made the decision it did. Use that feedback to improve the instructions in your personal template workspace's CLAUDE.md file.
Prompt engineering
How specific should my prompts be?
Be specific about what you want to build, but let Boomi Companion decide how to build it. For example, "Build a REST API that accepts a JSON payload with customer name and email, validates the fields, and posts to Salesforce" is much more effective than "Build a Salesforce integration." Include the details you would give to a colleague, such as endpoints, field names, and expected behavior. You do not need to dictate which Boomi shapes to use.
Should I give one big prompt or break it into steps?
For simple processes, a single detailed prompt works well. For complex, multi-component builds, consider breaking the work into phases: design first, then build, then test. You can start with "Design a process that does X; do not build it yet, just tell me your plan" and then refine before telling it to proceed.
How do I correct course without starting over?
Be direct. If Boomi Companion is heading in the wrong direction, interrupt it and say what you want changed. For example: "Stop, do not use a Message shape there, use a Map instead." You do not need to re-explain the whole task, just the specific correction. Boomi Companion retains the full conversation context and can adjust.
What if I am not sure how to describe what I want in Boomi terms?
Describe the business outcome instead: "I need to pick up files from an SFTP server every 15 minutes, convert them from CSV to JSON, and send them to a REST endpoint". Boomi Companion has the platform knowledge to translate business requirements into Boomi components.
Can I ask Boomi Companion to explain its choices?
Yes, and you should. Asking "Why did you use a Branch shape here instead of a Route?" or "Walk me through how this process handles errors" helps you learn and catch design decisions you may want to change before deploying.
How do I handle long or complex conversations?
Claude works best with focused context. If you are switching to a completely different task, consider clearing the context (/clear) and starting fresh rather than carrying a stale conversation history. If you are iterating on the same process: building, testing, and fixing, keep the context intact so Boomi Companion can reference prior decisions and test results.
Are there prompts I should avoid?
Avoid vague, open-ended prompts such as "Build me something cool" or "Make an integration." Also avoid over-specifying implementation details that conflict with Boomi's best practices. For example, dictating exact XML structures when Boomi Companion already knows the correct component schemas.
Can I give Boomi Companion reference material to work from?
Yes. You can paste API documentation, sample payloads, schema definitions, or requirements documents directly into the conversation. You can also place reference files in your project workspace; Boomi Companion can read and use them during the build. The more concrete your inputs (actual field names, real sample data, actual endpoint URLs), the better the output.
Support
Is Boomi Companion an officially supported Boomi Product?
Boomi Companion is a publicly available developer offering, not an officially supported Boomi product. It is provided as-is and is not covered by Boomi support agreements or SLAs. Boomi curates and maintains this offering on a best-effort basis; treat it as a self-service resource. Boomi reserves the right to modify or discontinue it at any time without notice.
