home / skills / composiohq / awesome-claude-skills / brightpearl-automation

brightpearl-automation skill

safe

/brightpearl-automation

This skill helps automate Brightpearl tasks by discovering tools with Rube MCP, validating connections, and executing tool workflows.

npx playbooks add skill composiohq/awesome-claude-skills --skill brightpearl-automation

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

2.9 KB

---
name: brightpearl-automation
description: "Automate Brightpearl tasks via Rube MCP (Composio). Always search tools first for current schemas."
requires:
  mcp: [rube]
---

# Brightpearl Automation via Rube MCP

Automate Brightpearl operations through Composio's Brightpearl toolkit via Rube MCP.

**Toolkit docs**: [composio.dev/toolkits/brightpearl](https://composio.dev/toolkits/brightpearl)

## Prerequisites

- Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
- Active Brightpearl connection via `RUBE_MANAGE_CONNECTIONS` with toolkit `brightpearl`
- Always call `RUBE_SEARCH_TOOLS` first to get current tool schemas

## Setup

**Get Rube MCP**: Add `https://rube.app/mcp` as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.

1. Verify Rube MCP is available by confirming `RUBE_SEARCH_TOOLS` responds
2. Call `RUBE_MANAGE_CONNECTIONS` with toolkit `brightpearl`
3. If connection is not ACTIVE, follow the returned auth link to complete setup
4. Confirm connection status shows ACTIVE before running any workflows

## Tool Discovery

Always discover available tools before executing workflows:

```
RUBE_SEARCH_TOOLS
queries: [{use_case: "Brightpearl operations", known_fields: ""}]
session: {generate_id: true}
```

This returns available tool slugs, input schemas, recommended execution plans, and known pitfalls.

## Core Workflow Pattern

### Step 1: Discover Available Tools

```
RUBE_SEARCH_TOOLS
queries: [{use_case: "your specific Brightpearl task"}]
session: {id: "existing_session_id"}
```

### Step 2: Check Connection

```
RUBE_MANAGE_CONNECTIONS
toolkits: ["brightpearl"]
session_id: "your_session_id"
```

### Step 3: Execute Tools

```
RUBE_MULTI_EXECUTE_TOOL
tools: [{
  tool_slug: "TOOL_SLUG_FROM_SEARCH",
  arguments: {/* schema-compliant args from search results */}
}]
memory: {}
session_id: "your_session_id"
```

## Known Pitfalls

- **Always search first**: Tool schemas change. Never hardcode tool slugs or arguments without calling `RUBE_SEARCH_TOOLS`
- **Check connection**: Verify `RUBE_MANAGE_CONNECTIONS` shows ACTIVE status before executing tools
- **Schema compliance**: Use exact field names and types from the search results
- **Memory parameter**: Always include `memory` in `RUBE_MULTI_EXECUTE_TOOL` calls, even if empty (`{}`)
- **Session reuse**: Reuse session IDs within a workflow. Generate new ones for new workflows
- **Pagination**: Check responses for pagination tokens and continue fetching until complete

## Quick Reference

| Operation | Approach |
|-----------|----------|
| Find tools | `RUBE_SEARCH_TOOLS` with Brightpearl-specific use case |
| Connect | `RUBE_MANAGE_CONNECTIONS` with toolkit `brightpearl` |
| Execute | `RUBE_MULTI_EXECUTE_TOOL` with discovered tool slugs |
| Bulk ops | `RUBE_REMOTE_WORKBENCH` with `run_composio_tool()` |
| Full schema | `RUBE_GET_TOOL_SCHEMAS` for tools with `schemaRef` |

---
*Powered by [Composio](https://composio.dev)*

Overview

This skill automates Brightpearl operations through Composio's Brightpearl toolkit using Rube MCP. It provides a reproducible workflow pattern to discover available tools, verify connections, and execute Brightpearl tasks programmatically. The skill emphasizes always querying tool schemas first to avoid breaking changes.

How this skill works

The skill uses Rube MCP endpoints to search for current tool schemas, manage Brightpearl connections, and run toolkit actions. Typical flow: call RUBE_SEARCH_TOOLS to fetch tool slugs and input schemas, confirm an ACTIVE Brightpearl connection via RUBE_MANAGE_CONNECTIONS, then run actions with RUBE_MULTI_EXECUTE_TOOL (including a memory object and session id). It supports pagination, session reuse, and bulk operations via RUBE_REMOTE_WORKBENCH.

When to use it

Automate order, inventory, or customer operations in Brightpearl
Run scheduled or bulk Brightpearl jobs reliably using discovered tool schemas
Integrate Brightpearl steps into larger automated workflows or agent chains
Perform programmatic checks and fixes that require exact schema compliance
Migrate or sync data where tool schemas might change frequently

Best practices

Always call RUBE_SEARCH_TOOLS first — do not hardcode tool slugs or argument shapes
Verify Brightpearl connection status with RUBE_MANAGE_CONNECTIONS and ensure it is ACTIVE before executing tools
Include an explicit memory object (even empty {}) in RUBE_MULTI_EXECUTE_TOOL calls
Reuse session_id for related workflow steps; generate new session ids for new workflows
Respect schema field types and names exactly as returned by the search tool; handle pagination tokens when present

Example use cases

Look up current Brightpearl toolkit tools, then create or update orders using the returned schema
Run a bulk inventory update via RUBE_REMOTE_WORKBENCH and run_composio_tool() across many SKUs
Automate customer creation and tagging by discovering the customer tool and executing it with schema-compliant args
Schedule nightly syncs: search tools, ensure connection, then execute multi-step workflows with a reused session_id
Build an agent that adapts to toolkit schema changes by always fetching schemas before each run

FAQ

Do I need API keys to use Rube MCP?

No API keys are required. Add the MCP endpoint (https://rube.app/mcp) to your client configuration and use the Rube MCP endpoints.

What if a tool schema changes mid-workflow?

Always call RUBE_SEARCH_TOOLS before each run or critical step. If schemas change, fetch the new schema, validate arguments, and regenerate the session or adjust inputs accordingly.