Arkady Plugin SDK

A Python SDK for building Arkady plugins.

Development

This repository uses just as its command runner. Install it with your preferred package manager, or with uv:

uv tool install rust-just

Common development commands:

just dev       # Sync default dev dependencies
just fmt       # Apply formatting fixes
just lint      # Format and apply lint fixes
just check     # Check lockfile, formatting, and linting
just test      # Run SDK tests
just build     # Build source and wheel distributions
just docs      # Generate schema documentation

LLM Polling Support

SDK 0.9.0 adds support for polling-based LLM invocation. A model can now declare the polling feature and implement polling methods, allowing plugins to submit long-running provider jobs and return later checks through a short request/response flow.

Polling results use three states:

• running returns plugin-owned state for the next check.
• succeeded returns the final LLM result.
• failed returns a terminal error.

Version Management

This SDK follows Semantic Versioning (a.b.c):

• a: Major version - Indicates significant architectural changes or incompatible API modifications
• b: Minor version - Indicates new feature additions while maintaining backward compatibility
• c: Patch version - Indicates backward-compatible bug fixes

For SDK Users

When depending on this SDK, it's recommended to specify version constraints that:

• Allow patch and minor updates for bug fixes and new features
• Prevent major version updates to avoid breaking changes

Example in your project's dependency management:

arkady_plugin >= 0.8

Manifest Version Reference

For the manifest specification, we've introduced two versioning fields:

• meta.version - The version of the manifest specification, designed for backward compatibility. When installing an older plugin to a newer Arkady, it's difficult to ensure breaking changes never occur, but at least Arkady can detect them through this field. Once an unsupported version is detected, Arkady will only use the supported parts of the plugin.
• meta.minimum_arkady_version - The minimum version of Arkady, designed for forward compatibility. When installing a newer plugin to an older Arkady, many new features may not be available, but showing the minimum Arkady version helps users understand how to upgrade.

Meta.Version Reference

Meta.MinimumArkadyVersion Reference