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 --api-key ... validates and stores an API key for future CLI and SDK usage
  5. ctxd login without --api-key only validates an existing API key from CTXD_API_KEY or the secure store

Base URL resolution order:

  1. base_url= passed to the client
  2. CTXD_BASE_URL
  3. ~/.ctxd/config.json
  4. https://mcp.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.8.tar.gz (9.9 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.8-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ctxd-0.1.8.tar.gz
Algorithm Hash digest
SHA256 4f81e2aaf5c55f35da0897993c5b494f4618f9513e7cc3a24bab69507b65fed8
MD5 878068fea0170c4e6820b5abd5e33655
BLAKE2b-256 255613500949b8528e6a2c7e6f0355665919c5f963da3ed9485d2cd08f88763a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ctxd-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d636628c104ae2feb290f898d85c61d71a33dacda5c36788312cab35b1dab08a
MD5 bc630b4ed08476967cd544c66a66bb96
BLAKE2b-256 bdffc33642ea2ef169f0447502b7aa37395150da80d566b805484dab6ca25e3d

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