Build tool servers + workflow specs for the Convilyn AI platform
Project description
Convilyn SDK (author)
Build tool servers + workflow specs for the Convilyn AI workflow platform.
Companion package: if you only want to call the Convilyn API (no server hosting, no workflow authoring), install
convilyninstead. The two packages are intentionally separate so consumers don't pay the uvicorn / FastAPI dependency cost.
Free to install, paid to deploy.
pip install convilyn-authoris free. You host your tool server on your own infrastructure (Lambda, Fargate, VM) at your own cost; Convilyn bills the caller of your tools, not you (see DEPLOYMENT §8).
Quick Start
pip install convilyn-author
convilyn-author init my-server
cd my-server
Edit server.py:
from convilyn_sdk import ConvilynServer
server = ConvilynServer(
name="my-server",
description="My custom tool server",
version="1.0.0",
)
@server.tool(description="Process text input")
async def process(text: str) -> dict:
return {"result": text.upper()}
if __name__ == "__main__":
# Production entry point: requires CONVILYN_HMAC_SECRET (fail-closed).
# For local development run `convilyn-author dev` instead — it serves
# without a secret. Or pass server.run(dev=True) / set
# CONVILYN_DEV_INSECURE=1 for a bare `python server.py` local run.
server.run()
CLI Commands
| Command | Description |
|---|---|
convilyn-author init <name> |
Scaffold a new project |
convilyn-author synth |
Compile → convilyn.manifest.json |
convilyn-author dev |
Start local server |
convilyn-author test |
Local compliance checks |
convilyn-author test --sandbox |
Test with Convilyn Sandbox Agent |
convilyn-author push --endpoint-url <url> |
Register a deployed tool server |
convilyn-author status <id> |
Check verification status |
convilyn-author workflow init <name> |
Scaffold a workflow spec |
convilyn-author workflow build |
Compile workflow → spec JSON |
convilyn-author doctor |
Environment + connectivity checks |
Testing
from convilyn_sdk.testing import ConvilynTestRunner
runner = ConvilynTestRunner(server=server)
result = await runner.call_tool("process", {"text": "hello"})
assert result.success
report = await runner.run_compliance_check()
assert report.all_passed
Environment Variables
| Variable | Description |
|---|---|
CONVILYN_DEVELOPER_KEY |
Your developer API key |
CONVILYN_PLATFORM_URL |
Platform base URL (default: https://api.convilyn.corenovus.com) |
CONVILYN_HOST |
Server bind host (default: 0.0.0.0) |
CONVILYN_PORT |
Server bind port (default: 8080) |
CONVILYN_HMAC_SECRET |
HMAC secret used to verify inbound /mcp requests from the Convilyn gateway. Required on every deployment — without it the server refuses to start (fail-closed). convilyn-author dev (and CONVILYN_DEV_INSECURE=1) serve without a secret for local development only. |
CONVILYN_HMAC_TOLERANCE_SECONDS |
Max clock skew vs gateway timestamp; default 300 (5 min) |
CONVILYN_LOG_LEVEL |
Log level (default: INFO) |
Migrating from convilyn to convilyn-author
The legacy convilyn binary was removed in v2.0.0 — use convilyn-author.
The only change is the binary name; all sub-commands, flags, and behaviour
are identical:
# Before
convilyn init my-server
convilyn dev --port 8080
convilyn push --endpoint-url https://my-server.example.com
# After
convilyn-author init my-server
convilyn-author dev --port 8080
convilyn-author push --endpoint-url https://my-server.example.com
Why the rename: the consumer SDK (PyPI convilyn, the client for API
callers) also ships a convilyn binary. Two packages cannot coexist
in one environment while both claiming the same console script. The
author SDK now owns convilyn-author; the consumer SDK keeps convilyn.
Next
- DEPLOYMENT.md — Lambda / Fargate / VM walkthroughs + HMAC contract
- STABILITY.md — what the public API is and the SemVer / deprecation promise behind it
- CHANGELOG.md — version history
- examples/ — runnable example tool servers + workflows
- AGENT.md — guidance for AI coding agents contributing to this SDK
Licence
Apache-2.0. See LICENSE.
Project details
Release history Release notifications | RSS feed
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