Skip to main content

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

Metadata

Release files for arkady-plugin-sdk 0.10.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for arkady-plugin-sdk 0.10.4
File Size Uploaded
arkady_plugin_sdk-0.10.4.tar.gz 321.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for arkady-plugin-sdk 0.10.4
File Interpreter ABI Platform
arkady_plugin_sdk-0.10.4-py3-none-any.whl Python 3 none any Details

Total release size: 702.8 kB

Release files / arkady_plugin_sdk-0.10.4.tar.gz

Download URL arkady_plugin_sdk-0.10.4.tar.gz
Size 321.8 kB
Tags Source
SHA-256 checksum
How to use checksums
f280c10ae35a39594a1d500d83bf662f51b59908a5eff067d640550334b23a41
BLAKE2b-256 checksum
How to use checksums
6cab63b063419c08b409658c156e3e3a347f04b6cd65f18249bb8ea65ba20630
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.

Transparency log

Release files / arkady_plugin_sdk-0.10.4-py3-none-any.whl

Download URL arkady_plugin_sdk-0.10.4-py3-none-any.whl
Size 381.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ffd798da66ecb708e0b52039e954651563de892415e807a6d14d65355b2bde1c
BLAKE2b-256 checksum
How to use checksums
25a2232ad298457dfbd5f63a19ce11febd2dd9854151c596068c660502750490
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.10.4 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page