Skip to main content

Public Python SDK and CLI for the ctxd platform.

Project description

ctxd

Public Python SDK and CLI for the ctxd platform.

Install:

pip install ctxd

The SDK exposes sync and async clients:

  • Client
  • AsyncClient

Authentication:

  1. Preferred for headless and scripts: create a user-bound API key through the authenticated application backend
  2. Provide it with Client(api_key=...) or CTXD_API_KEY
  3. The SDK sends that key as the bearer token directly to the MCP server
  4. ctxd login is still supported for interactive local OAuth login
  5. If CTXD_API_KEY is set and you run ctxd login, the CLI first validates the key with get_profile(). If valid, it skips OAuth and reports that you are already authenticated. If invalid, it warns and asks whether to continue with interactive login.

Base URL resolution order:

  1. base_url= passed to the client
  2. CTXD_BASE_URL
  3. ~/.ctxd/config.json
  4. https://mcp.ctxd.dev

Auth API URL resolution order:

  1. CTXD_AUTH_API_URL
  2. https://api.ctxd.dev

Example:

from ctxd import Client

client = Client(api_key="297e24c4-4ee9-4739-828f-48f57f48ce11")

results = client.search("text:deployment application:slack")
profile = client.get_profile()
document = client.fetch_document("doc-123")

API key example:

from ctxd import Client

client = Client(api_key="297e24c4-4ee9-4739-828f-48f57f48ce11")
results = client.search("text:deployment application:slack")

Async example:

from ctxd import AsyncClient

async with AsyncClient(api_key="297e24c4-4ee9-4739-828f-48f57f48ce11") as client:
    results = await client.search("text:deployment")

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

ctxd-0.1.7.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

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

ctxd-0.1.7-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file ctxd-0.1.7.tar.gz.

File metadata

  • Download URL: ctxd-0.1.7.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.26

File hashes

Hashes for ctxd-0.1.7.tar.gz
Algorithm Hash digest
SHA256 6f711325afedfddb1b0986a6e85d27f60aa1ac8b022c955105094e916e26515a
MD5 27f767469c77320b163ec8f00d1cb653
BLAKE2b-256 7d0ca00549f79b78fbaab4c6b4a44c84eb48bd146285f3a7bea41c7e7ace9c1e

See more details on using hashes here.

File details

Details for the file ctxd-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: ctxd-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.26

File hashes

Hashes for ctxd-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1328e3d147741cdf86e79d8305db4b43de6aa3412abe62c147162515ac44b48a
MD5 780c0b137f5fea7cecb3f43afd006f2f
BLAKE2b-256 f2a528e6e3f8d4d8755fdab3951a24767346609af63116f1945f18a26effec25

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