Skip to main content

No project description provided

Project description

Klavis Python Library

fern shield pypi

The Klavis Python library provides convenient access to the Klavis API from Python.

Installation

pip install klavis

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from klavis import Klavis

client = Klavis(
    api_key="YOUR_API_KEY",
)
client.mcp_server.call_tools(
    server_url="serverUrl",
    tool_name="toolName",
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API.

import asyncio

from klavis import AsyncKlavis

client = AsyncKlavis(
    api_key="YOUR_API_KEY",
)


async def main() -> None:
    await client.mcp_server.call_tools(
        server_url="serverUrl",
        tool_name="toolName",
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from klavis.core.api_error import ApiError

try:
    client.mcp_server.call_tools(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from klavis import Klavis

client = Klavis(
    ...,
)
response = client.mcp_server.with_raw_response.call_tools(...)
print(response.headers)  # access the response headers
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.mcp_server.call_tools(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from klavis import Klavis

client = Klavis(
    ...,
    timeout=20.0,
)


# Override timeout for a specific method
client.mcp_server.call_tools(..., request_options={
    "timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from klavis import Klavis

client = Klavis(
    ...,
    httpx_client=httpx.Client(
        proxies="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

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

klavis-1.4.1.tar.gz (58.3 kB view details)

Uploaded Source

Built Distribution

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

klavis-1.4.1-py3-none-any.whl (158.1 kB view details)

Uploaded Python 3

File details

Details for the file klavis-1.4.1.tar.gz.

File metadata

  • Download URL: klavis-1.4.1.tar.gz
  • Upload date:
  • Size: 58.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/6.11.0-1018-azure

File hashes

Hashes for klavis-1.4.1.tar.gz
Algorithm Hash digest
SHA256 a93f31b9dd69e7706d3704c4cbb4d0af5e59b12c0004c3bd81cf490dcccea5e7
MD5 ab172a36c7b2337f507de6609aa56362
BLAKE2b-256 23117bb069087950431261df0bca47172a94accb2b889ef4a926e7d157c0e4cd

See more details on using hashes here.

File details

Details for the file klavis-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: klavis-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 158.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/6.11.0-1018-azure

File hashes

Hashes for klavis-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6836d4426519de57c9e6294ddc63ef9ea276e7490b139d0906197b9f3f8c273a
MD5 f743475f205ecb1483fd1e8b4f251b90
BLAKE2b-256 4becce2241c5d87f5cccc33e476ba108dc706c25ad7c9695c76fefd0cb155f79

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