PHPackages                             plotdesk/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. [Utility & Helpers](/categories/utility)
4. /
5. plotdesk/plugin-sdk

ActiveLibrary[Utility & Helpers](/categories/utility)

plotdesk/plugin-sdk
===================

SDK for developing plotdesk plugins

v1.0.0(3mo ago)02proprietaryPHPPHP ^8.2

Since Apr 13Pushed 3mo agoCompare

[ Source](https://github.com/plotdesk/plotdesk-plugin-sdk)[ Packagist](https://packagist.org/packages/plotdesk/plugin-sdk)[ RSS](/packages/plotdesk-plugin-sdk/feed)WikiDiscussions main Synced 3w ago

READMEChangelogDependenciesVersions (2)Used By (0)

plotdesk Plugin SDK
===================

[](#plotdesk-plugin-sdk)

Official SDK for developing plotdesk plugins. Provides base classes, type stubs for IDE autocompletion, and a scaffolding CLI to create new plugin projects.

Reference Implementation
------------------------

[](#reference-implementation)

Before building your own plugin, study the official example plugin which demonstrates every feature this SDK supports:

****

It is a production-ready reference implementation with multiple apps, custom pages, custom chat interfaces, rich payload components, event listeners, scheduled tasks, full EN/DE translations and perfect light/dark mode support. Whenever you are unsure how something should be structured, this repository is the canonical source of truth.

Quick Start
-----------

[](#quick-start)

```
# Install the SDK as a dev dependency
composer require plotdesk/plugin-sdk --dev

# Create a new plugin project
vendor/bin/plotdesk-plugin create my-awesome-plugin
cd my-awesome-plugin
composer install
```

This generates a complete plugin structure with:

- `plugin.json` manifest
- App class with example AI function
- Service provider
- Routes, translations, migrations directories
- Cursor rules for AI-assisted development
- Proper `.gitignore` (vendor/ and dist/ are committed!)

What Plugins Can Do
-------------------

[](#what-plugins-can-do)

- **AI Functions**: Register apps with custom tool calls for the AI
- **Custom Pages**: Own Inertia pages with pre-built Vue components
- **Custom Group Interfaces**: New "View Mode" types in Group Settings
- **Navigation**: Menu items in the sidebar
- **Permissions**: Custom global and group-level permissions
- **Routes**: Web and API endpoints under `/plugins/{id}/`
- **Chat Payloads**: Rich UI components in chat messages
- **Database**: Own tables with migrations
- **AI Access**: Direct AI calls via `PluginAi::call()` or full chat via `PluginChat::run()`
- **Events**: React to chat.created, message.sent, user.joined\_team, and more
- **Queue Jobs, Scheduled Tasks, Broadcasting, Notifications, Mail, Cache**

Plugin Structure
----------------

[](#plugin-structure)

```
my-awesome-plugin/
  plugin.json              # Plugin manifest (apps, permissions, navigation, interfaces)
  composer.json             # Dependencies (SDK as dev dependency)
  .gitignore                # vendor/ and dist/ are NOT ignored!
  src/
    MyAwesomePlugin.php     # Service provider (extends PluginServiceProvider)
    Apps/
      MyAwesome/
        MyAwesomeApp.php    # App class (extends BasicApp, defines AI functions)
    Http/Controllers/       # Optional: custom controllers
    Models/                 # Optional: Eloquent models
  vendor/                   # Composer dependencies (committed to git!)
  dist/                     # Pre-built frontend assets (committed to git!)
    pages/                  # Compiled Vue pages as ESM
    payloads/               # Compiled payload components
    interfaces/             # Compiled interface components
    css/plugin.css          # Compiled Tailwind CSS
  routes/
    web.php                 # Web routes (prefix: /plugins/{id}/)
    api.php                 # API routes (prefix: /api/plugins/{id}/)
  resources/lang/           # Translations
  database/migrations/      # Database migrations (table prefix required!)
  .cursor/rules/            # AI IDE rules for development assistance

```

AI Function Example
-------------------

[](#ai-function-example)

```
class MyAwesomeApp extends BasicApp
{
    public function getFunctions(): array
    {
        return [[
            'name' => 'search_customers',
            'label' => 'Search Customers',
            'description' => 'Search the customer database',
            'parameters' => [
                'type' => 'object',
                'properties' => [
                    'query' => ['type' => 'string', 'description' => 'Search query'],
                ],
                'required' => ['query'],
            ],
        ]];
    }

    public function SearchCustomers($arguments, ChatMessage $message, ChatMessageApp $chatMessageApp): string
    {
        $query = data_get($arguments, 'query');
        $message->setLoading('search', 'Searching customers...');

        $results = $this->doSearch($query);

        $message->removeLoading('search');
        $message->attachPayload('search_customers', $arguments, ['results' => $results]);

        return "Found " . count($results) . " customers for: {$query}";
    }
}
```

Direct AI Access
----------------

[](#direct-ai-access)

```
// Simple AI call (prompt in, text out)
$result = PluginAi::call(
    team: $this->team,
    systemPrompt: 'Classify this lead as hot, warm, or cold.',
    userPrompt: $leadDescription,
    contextType: 'plugin:my-plugin:classify',
);

// Full chat with platform access (silos, tables, apps, etc.)
$analysis = PluginChat::run(
    team: $this->team,
    groupId: $groupId,
    userMessage: 'Analyze the customer history for #123',
    contextType: 'plugin:my-plugin:analyze',
);
```

Custom Group Interface
----------------------

[](#custom-group-interface)

```
{
  "interfaces": [{
    "id": "my-dashboard",
    "name": "Custom Dashboard",
    "description": "Interactive customer dashboard",
    "component": "Dashboard",
    "default_chat_enabled": true,
    "settings_fields": [
      {"key": "api_url", "type": "url", "label": "API Endpoint"},
      {"key": "refresh", "type": "select", "label": "Refresh", "options": [
        {"value": "30", "label": "30s"}, {"value": "60", "label": "1min"}
      ]}
    ]
  }]
}
```

The component is loaded from `dist/interfaces/Dashboard.js` and receives `group`, `chat`, and `interfaceSettings` as props.

Important Conventions
---------------------

[](#important-conventions)

- **Table prefix**: All database tables must use the plugin ID as prefix (e.g., `my_plugin_contacts`)
- **App ID prefix**: App IDs must start with the plugin ID
- **vendor/ committed**: The plugin ships its own dependencies (no `composer install` on the server)
- **dist/ committed**: Pre-built frontend assets are committed (no `yarn build` on the server)
- **Permissions namespaced**: Use unique names like `view_my_dashboard`, not `view_dashboard`

IDE Support
-----------

[](#ide-support)

The SDK includes type stubs for all plotdesk classes (ChatMessage, Team, User, Group, StorageService, BasicApp, etc.). Your IDE will provide full autocompletion for plotdesk APIs.

The generated `.cursor/rules/plotdesk-plugin.mdc` file provides comprehensive AI assistance rules for Cursor IDE, documenting all available APIs, patterns, and conventions.

Installation on plotdesk
------------------------

[](#installation-on-plotdesk)

Plugins are installed via the Plugin Management UI in plotdesk (Platform Admin > Plugins). The admin connects GitHub, selects the plugin repository, and installs it with one click. Auto-updates are supported via GitHub webhooks.

Requirements
------------

[](#requirements)

- PHP 8.2+
- plotdesk 4.50+

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance81

Actively maintained with recent releases

Popularity2

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity46

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

Unknown

Total

1

Last Release

102d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/230516220?v=4)[Plotdesk](/maintainers/Plotdesk)[@plotdesk](https://github.com/plotdesk)

---

Top Contributors

[![TorbenLeuschnerSayDigital](https://avatars.githubusercontent.com/u/220703432?v=4)](https://github.com/TorbenLeuschnerSayDigital "TorbenLeuschnerSayDigital (3 commits)")

### Embed Badge

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

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

###  Alternatives

[asantibanez/livewire-calendar

Laravel Livewire calendar component

97091.4k1](/packages/asantibanez-livewire-calendar)[monsieurbiz/sylius-sales-reports-plugin

A simple plugin to have sales reports in Sylius

1231.1k](/packages/monsieurbiz-sylius-sales-reports-plugin)

PHPackages © 2026

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