PHPackages                             board/plugin-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. board/plugin-sdk

ActiveLibrary

board/plugin-sdk
================

SDK and contracts for building Board Kanban plugins (Power-Ups).

v0.2.9(yesterday)08↑2900%1MITPHPPHP ^8.3

Since Jul 7Pushed todayCompare

[ Source](https://github.com/B-o-a-r-d/Board-Plugin-SDK)[ Packagist](https://packagist.org/packages/board/plugin-sdk)[ RSS](/packages/board-plugin-sdk/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (2)Versions (12)Used By (1)

Board Plugin SDK
================

[](#board-plugin-sdk)

 Contracts and value objects for building [Board](https://github.com/B-o-a-r-d/board) Kanban plugins (Power-Ups).

 [![PHP 8.3](https://camo.githubusercontent.com/2bace8bb56a21d62a4c1c2e2018eb2e83eff46e07cab21c26ca42feda0bdd46e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e332d3737374242343f6c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/2bace8bb56a21d62a4c1c2e2018eb2e83eff46e07cab21c26ca42feda0bdd46e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e332d3737374242343f6c6f676f3d706870266c6f676f436f6c6f723d7768697465) [![License MIT](https://camo.githubusercontent.com/6c290d3fa30f4a51454757590f2beec29a83cccdfcd9945e2c0d387af01477f3/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d323263353565)](https://camo.githubusercontent.com/6c290d3fa30f4a51454757590f2beec29a83cccdfcd9945e2c0d387af01477f3/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d323263353565)

---

A Board plugin is an **ordinary Composer package** that depends on **this SDK only**— never on the host application. That's what lets plugins ship and version independently: `composer require board/plugin-github`, and Laravel package auto-discovery makes the Power-Up available with no core changes.

The host owns storage, the configuration UI, OAuth, list rendering, caching, realtime and the MCP server. Plugins stay thin: they describe themselves and implement the capabilities they support.

Install
-------

[](#install)

```
composer require board/plugin-sdk
```

Capabilities
------------

[](#capabilities)

Every plugin implements `Plugin`. Capabilities are **opt-in** interfaces — the host inspects `instanceof` to know what a plugin can do.

InterfaceWhat the plugin can do`Contracts\Plugin`Identity, icon, config fields, OAuth requirement (required)`Contracts\ProvidesListSource`Feed a list with read-only "virtual cards" (commits, PRs, pipelines…)`Contracts\EnrichesCards`Attach external refs to a card and resolve them into a status widget`Contracts\DefinesActivities`Log activities and get a dedicated tab in the activity slide-over`Contracts\ProvidesMcpTools`Contribute tools to the host's MCP server`Contracts\ProvidesOAuth`Declare a provider's OAuth endpoints; the host drives the flow`Contracts\ProvidesCardFields`Inject custom fields into cards (type, options, sidebar/content placement)`Contracts\ProvidesAutomationActions`Contribute actions to the automation builder, run in the host's pipeline sandbox`Contracts\PluginContext`*(host-bound)* let decoupled plugin code read board state safelyValue objects: `PluginListItem` — a read-only virtual card (`title`, `subtitle`, `url`, `badge`, `badgeColor`, `icon`, `timestamp`) — and `PluginToast` — a toast an automation action returns for the host to push to the acting user (`message`, `description`, `type`, `duration`, link `actions` opened in a new tab).

Building a plugin
-----------------

[](#building-a-plugin)

1. **Implement `Plugin`** (plus any capabilities):

```
use Board\PluginSdk\Contracts\Plugin;
use Board\PluginSdk\Contracts\ProvidesListSource;
use Board\PluginSdk\PluginListItem;
use Illuminate\Support\Collection;

class HelloPlugin implements Plugin, ProvidesListSource
{
    public static function key(): string { return 'hello'; }
    public function label(): string { return 'Hello'; }
    public function description(): string { return __('hello::messages.description'); }
    public function icon(): string { return 'hand-waving'; }      // phosphor icon name
    public function requiresOAuth(): bool { return false; }
    public function oauthProvider(): ?string { return null; }
    public function configFields(array $config = []): array { return []; }

    public function sourceModes(): array
    {
        return [['key' => 'greetings', 'label' => __('hello::messages.greetings')]];
    }

    public function listConfigFields(array $config = []): array { return []; }

    public function items(array $config, string $mode, array $sourceConfig): Collection
    {
        return collect(['Bonjour', 'Hello', 'Hola'])->map(fn ($g, $i) => new PluginListItem(
            externalRef: (string) $i,
            title: $g,
            icon: 'hand-waving',
        ));
    }
}
```

2. **Register it from a service provider** by extending the SDK base — it wires the registry *and* loads your package's translations under the `::` namespace:

```
use Board\PluginSdk\Contracts\Plugin;
use Board\PluginSdk\PluginServiceProvider;

class HelloServiceProvider extends PluginServiceProvider
{
    protected function plugin(): Plugin { return new HelloPlugin; }
}
```

3. **Expose the provider** for auto-discovery in your `composer.json`:

```
{
    "require": { "board/plugin-sdk": "^0.2" },
    "extra": { "laravel": { "providers": ["Vendor\\Hello\\HelloServiceProvider"] } },
    "autoload": { "psr-4": { "Vendor\\Hello\\": "src/" } }
}
```

That's it — `composer require vendor/hello` and the Power-Up shows up in **Board → Power-Ups**.

Translations
------------

[](#translations)

Plugins ship their own strings as files (never in the host core). The base `PluginServiceProvider` loads `lang/` under the plugin key, so use `__('hello::messages.some.key')`. Provide `lang/{en,fr,es}/messages.php`.

MCP tools
---------

[](#mcp-tools)

Implement `ProvidesMcpTools::mcpTools()` returning your tool class-strings (each extending Laravel MCP's `Tool`). Require `laravel/mcp` in your package. Tools that need host state (a board's stored config) resolve it through the host-bound `Contracts\PluginContext` — so your tool never depends on the app.

Versioning
----------

[](#versioning)

Semantic versioning per package. Breaking changes to these contracts bump the SDK **major**; plugins pin a range (`"board/plugin-sdk": "^0.2"`).

License
-------

[](#license)

MIT. See the [Board](https://github.com/B-o-a-r-d/board) app and the [GitHub plugin](https://github.com/B-o-a-r-d/Github-Plugin) for full examples.

###  Health Score

42

—

FairBetter than 88% of packages

Maintenance100

Actively maintained with recent releases

Popularity7

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

11

Last Release

1d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8fb3e7935d578f288802937e00c80e3bfc6a3608d815e401bef011e7d35b3f7e?d=identicon)[JibayMcs](/maintainers/JibayMcs)

---

Top Contributors

[![JibayMcs](https://avatars.githubusercontent.com/u/7621593?v=4)](https://github.com/JibayMcs "JibayMcs (8 commits)")

---

Tags

pluginsdkboardkanban

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/board-plugin-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/board-plugin-sdk/health.svg)](https://phpackages.com/packages/board-plugin-sdk)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)