Skip to main content

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 convilyn instead. 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-author is 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

convilyn_author-2.1.1b1.tar.gz (142.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

convilyn_author-2.1.1b1-py3-none-any.whl (83.4 kB view details)

Uploaded Python 3

File details

Details for the file convilyn_author-2.1.1b1.tar.gz.

File metadata

  • Download URL: convilyn_author-2.1.1b1.tar.gz
  • Upload date:
  • Size: 142.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for convilyn_author-2.1.1b1.tar.gz
Algorithm Hash digest
SHA256 02a68d20cfaad6880eb6935b586deda4c42b281ae48754ecc73154174c2772c2
MD5 1a6db3b97ea539725d3b8656012d66c5
BLAKE2b-256 3f59d6d5b7f2467a54e0b2cfa71a2e7446008d928d34e125e605009824e576e8

See more details on using hashes here.

File details

Details for the file convilyn_author-2.1.1b1-py3-none-any.whl.

File metadata

File hashes

Hashes for convilyn_author-2.1.1b1-py3-none-any.whl
Algorithm Hash digest
SHA256 a7deff7ae253d0266af704093dc18ad2437a448051b8e0c9aa181fc974694df8
MD5 381d543f9fc21cc2b62caa907edc375c
BLAKE2b-256 4efedbe8e4b3155e0ed82d8479cc4cfd8dfe1835212b942f4690c0b33e4dc244

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page