mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-09-15 23:31:05 +00:00
88ed21165b
* docs: rebuild documentation site with VitePress * docs: address VitePress review feedback * docs: complete locale redirect validation
101 lines
2.8 KiB
Markdown
101 lines
2.8 KiB
Markdown
---
|
|
title: Plugin Development
|
|
description: Create, register, configure, test, and publish a ReMe plugin.
|
|
---
|
|
|
|
# Plugin Development
|
|
|
|
A ReMe plugin is a regular Python distribution exposed through the `reme.plugins` entry-point group. Its package-level `plugin.yaml` can register Step and Component backends and provide default Application configuration.
|
|
|
|
## Minimal structure
|
|
|
|
```text
|
|
my-plugin/
|
|
├── pyproject.toml
|
|
└── src/my_plugin/
|
|
├── __init__.py
|
|
├── plugin.yaml
|
|
└── steps.py
|
|
```
|
|
|
|
`pyproject.toml`:
|
|
|
|
```toml
|
|
[project.entry-points."reme.plugins"]
|
|
my-plugin = "my_plugin"
|
|
```
|
|
|
|
`plugin.yaml`:
|
|
|
|
```yaml
|
|
name: my-plugin
|
|
backends:
|
|
my_step: my_plugin.steps:MyStep
|
|
application_defaults:
|
|
jobs:
|
|
my_action:
|
|
backend: base
|
|
description: Run my plugin action
|
|
parameters:
|
|
type: object
|
|
properties:
|
|
text: { type: string }
|
|
required: [text]
|
|
steps:
|
|
- backend: my_step
|
|
```
|
|
|
|
## Implement a Step
|
|
|
|
```python
|
|
from reme.components.component_registry import R
|
|
from reme.steps.base_step import BaseStep
|
|
|
|
|
|
@R.register("my_step")
|
|
class MyStep(BaseStep):
|
|
async def execute(self):
|
|
self.context.response.answer = self.context.data["text"]
|
|
```
|
|
|
|
Step instances belong to one Job invocation. Put shared in-memory state under a narrow `app_context.metadata` key. Promote state that needs lifecycle, locking, or persistence to a Component or workspace file.
|
|
|
|
## Configuration merge
|
|
|
|
`application_defaults` is a partial `ApplicationConfig`:
|
|
|
|
```text
|
|
plugin defaults < selected/default config < CLI overrides
|
|
```
|
|
|
|
Plugins must not rewrite user configuration. Their backends enter an Application-local registry only when the plugin appears in that Application's `plugins` list.
|
|
|
|
## Local validation
|
|
|
|
```bash
|
|
reme plugins validate ./path/to/my-plugin
|
|
reme plugins install ./path/to/my-plugin --editable
|
|
reme plugins list
|
|
reme plugins show my-plugin
|
|
reme start plugins='["my-plugin"]'
|
|
reme my_action text=hello
|
|
```
|
|
|
|
Validation imports plugin code, so run it only for trusted sources.
|
|
|
|
## Test boundaries
|
|
|
|
- create workspaces with `tmp_path`;
|
|
- mock network, model, and subprocess boundaries;
|
|
- verify disabled plugins do not mutate the built-in registry;
|
|
- verify plugin defaults and explicit configuration precedence;
|
|
- keep tasks, clients, and executors under Component lifecycle;
|
|
- never delete or rewrite user source files to repair derived state.
|
|
|
|
The repository's Daily Paper, Auto Fin, LME, and BEAM plugins are complete examples.
|
|
|
|
## Compatibility
|
|
|
|
Legacy Python Plugin descriptors and the `reme.configs` entry point remain supported during migration, but new plugins should use `plugin.yaml`. Enablement always belongs to an Application rather than a process-global switch.
|
|
|
|
See [Plugin Management](./plugin_management.md) for installation, upgrades, and removal.
|