Arkady Plugin SDK
Python SDK для разработки плагинов Arkady.
Разработка
Репозиторий использует just как командный раннер.
Установить можно любым удобным пакетным менеджером или через uv:
uv tool install rust-just
Основные команды разработки:
just dev # Синхронизировать дефолтные dev-зависимости
just fmt # Применить автоформатирование
just lint # Форматирование + автофиксы линта
just check # Проверить lockfile, форматирование и линт
just test # Запустить тесты SDK
just build # Собрать source- и wheel-дистрибутивы
just docs # Сгенерировать документацию по схемам
Поддержка polling-режима для LLM
SDK 0.9.0 добавляет поддержку вызова LLM через polling. Теперь модель может
объявить фичу polling и реализовать методы опроса — плагины могут отправлять
долгоживущие задания провайдеру и позже проверять статус через короткий
цикл запрос/ответ.
Результаты polling бывают трёх состояний:
running— возвращает состояние, которым владеет плагин, для следующей проверки.succeeded— возвращает финальный результат LLM.failed— возвращает терминальную ошибку.
Управление версиями
SDK следует Semantic Versioning (a.b.c):
- a: мажорная версия — значимые архитектурные изменения или несовместимые правки API
- b: минорная версия — добавление новых фич с сохранением обратной совместимости
- c: патч-версия — обратно совместимые исправления багов
Для пользователей SDK
При объявлении зависимости от этого SDK рекомендуется указывать ограничения версии так, чтобы:
- разрешать патч- и минорные обновления (баг-фиксы и новые фичи)
- запрещать мажорные обновления во избежание breaking changes
Пример в зависимостях вашего проекта:
arkady_plugin >= 0.8
Справочник по версиям манифеста
Для спецификации манифеста введены два поля версионирования:
meta.version— версия спецификации манифеста, для обратной совместимости. При установке старого плагина в новую версию Arkady сложно гарантировать отсутствие breaking changes, но по этому полю Arkady может их обнаружить. Если версия не поддерживается — Arkady использует только поддерживаемую часть функционала плагина.meta.minimum_arkady_version— минимальная версия Arkady, для прямой совместимости. При установке нового плагина в старую версию Arkady многие новые фичи могут быть недоступны, но указание минимальной версии Arkady подсказывает пользователю, до какой версии нужно обновиться.
Справочник Meta.Version
| Версия манифеста | Описание |
|---|---|
| 0.0.2 | Поскольку ToolProviderType теперь поддерживает mcp, старая реализация ломается при выборе пользователем mcp-инструмента в Arkady — версия поднята до 0.0.2, чтобы Arkady знал: mcp отключён при meta.version ниже 0.0.2. |
| 0.0.1 | Первый релиз |
Справочник Meta.MinimumArkadyVersion
| Минимальная версия Arkady | Версия SDK | Описание |
|---|---|---|
| 1.2.0 | 0.2.0 | Поддержка получения информации о приложении |
| 1.4.0 | 0.0.1-beta.49 | Поддержка мультимодального вывода LLM |
| 1.4.0 | 0.3.1 | Поддержка OAuth для плагинов |
| 1.5.1 | 0.4.0 | Поддержка типа параметра dynamic-select |
| 1.5.1 | 0.4.0 | Поддержка structured output для LLM |
| 1.6.0 | 0.4.1 | Поддержка поля dark-icon в манифесте |
| 1.7.0 | 0.4.2 | Поддержка OAuth для плагинов |
| 1.8.1 | 0.4.4 | Поддержка filename в MultiModalPromptMessageContent |
| 1.9.0 | 0.5.0 | Поддержка функционала Datasource для плагинов |
| 1.10.0 | 0.6.0 | Поддержка функционала Trigger для плагинов |
| 1.11.0 | 0.7.0 | Поддержка мультимодального Reranking / Embeddings |
| 1.14.0 | 0.8.1 | Чистка зависимостей и структуры проекта |
| 1.14.2 | 0.9.0 | Поддержка polling-вызовов LLM-плагинов |
English version: README.en.md
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file arkady_plugin-0.10.3.tar.gz.
File metadata
- Download URL: arkady_plugin-0.10.3.tar.gz
- Upload date:
- Size: 321.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5fd2025952f98041cf1d653a06d57b9285ed0a98ae794164efe902890d2f0711
|
|
| MD5 |
4211c00b32b5ac2e2c7da755298e684f
|
|
| BLAKE2b-256 |
fe14f5b1f956641193ace9dc69d08a8432be5bc235475e7f1ca591c7d65260d6
|
Provenance
The following attestation bundles were made for arkady_plugin-0.10.3.tar.gz:
Publisher:
release.yml on reraaaaa/arkady-plugin-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
arkady_plugin-0.10.3.tar.gz -
Subject digest:
5fd2025952f98041cf1d653a06d57b9285ed0a98ae794164efe902890d2f0711 - Sigstore transparency entry: 2451616327
- Sigstore integration time:
-
Permalink:
reraaaaa/arkady-plugin-sdk@32ceec5724075ba43a55b930a30db8c042c968e7 -
Branch / Tag:
refs/tags/v0.10.3 - Owner: https://github.com/reraaaaa
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@32ceec5724075ba43a55b930a30db8c042c968e7 -
Trigger Event:
push
-
Statement type:
File details
Details for the file arkady_plugin-0.10.3-py3-none-any.whl.
File metadata
- Download URL: arkady_plugin-0.10.3-py3-none-any.whl
- Upload date:
- Size: 380.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a8ed1cff7f98b598e8b7fcb0fd59899da0d716d39f7f93beceef65ef67877c14
|
|
| MD5 |
14ed0bd70a4fcc2448377352c5305c09
|
|
| BLAKE2b-256 |
9b588876d124f1df5f4477f1b5b3a3d13799bfffcf58c658ea03f34fdb89279f
|
Provenance
The following attestation bundles were made for arkady_plugin-0.10.3-py3-none-any.whl:
Publisher:
release.yml on reraaaaa/arkady-plugin-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
arkady_plugin-0.10.3-py3-none-any.whl -
Subject digest:
a8ed1cff7f98b598e8b7fcb0fd59899da0d716d39f7f93beceef65ef67877c14 - Sigstore transparency entry: 2451616509
- Sigstore integration time:
-
Permalink:
reraaaaa/arkady-plugin-sdk@32ceec5724075ba43a55b930a30db8c042c968e7 -
Branch / Tag:
refs/tags/v0.10.3 - Owner: https://github.com/reraaaaa
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@32ceec5724075ba43a55b930a30db8c042c968e7 -
Trigger Event:
push
-
Statement type:
