Skip to main content

Open-source CLI, SDK, and MCP bridge for the hosted VelocityBrain coding-agent reuse API

Project description

VelocityBrain Client

Open-source CLI, Python SDK, and MCP bridge for the hosted VelocityBrain API.

Scope

This package contains the public distribution layer only:

  • Python client
  • hosted CLI
  • MCP bridge
  • integration examples

This package does not contain the hosted backend, ranking logic, reuse engine, dashboard, or private operational tooling.

Install

pip install velocitybrain-client

For local development:

pip install -e ".[dev]"

Configure

Set your API key with an environment variable:

export VELOCITYBRAIN_API_KEY="vb_live_xxx"

Or save it with the CLI:

velocitybrain config --set-key vb_live_xxx

Optional:

velocitybrain config --set-key vb_live_xxx --base-url https://your-hosted-base-url

The default hosted base URL is https://velocity.linkitapp.in.

CLI

The public CLI exposes three commands:

  • velocitybrain run <task>
  • velocitybrain status
  • velocitybrain config --set-key <key>

Examples:

velocitybrain run "Which files should I edit to change hosted auth safely?"
velocitybrain run --json --response-style lite "Summarize the API key flow."
velocitybrain status

run returns a normalized payload with:

  • result
  • reused
  • reuse_confidence
  • tokens_saved
  • percent_saved

Python SDK

from velocitybrain_client import VelocityBrainClient

with VelocityBrainClient(api_key="vb_live_xxx") as client:
    result = client.run(
        "Map the hosted auth and API key flow in this repo.",
        response_style="lite",
    )
    print(result)

    usage = client.get_usage_stats()
    print(usage)

MCP Bridge

Start the MCP bridge:

velocitybrain-mcp

The public MCP bridge exposes two tools:

  • run_agent
  • usage

It requires VELOCITYBRAIN_API_KEY to be set in the environment before launch.

Example config files are available in:

  • integrations/mcp/mcpServers.velocitybrain.json
  • integrations/openclaw/mcpServers.json
  • integrations/hermes/config.velocitybrain.yaml
  • integrations/claude/setup.sh

Hosted API Surface

The public client is limited to these hosted endpoints:

  • POST /v1/run
  • GET /v1/usage

Development Checks

Run the public package checks before release:

pytest
python scripts/check_public_boundary.py
python -m build

The boundary check ensures the public package does not import private runtime modules from the main product codebase.

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

velocitybrain_client-1.0.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

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

velocitybrain_client-1.0.1-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file velocitybrain_client-1.0.1.tar.gz.

File metadata

  • Download URL: velocitybrain_client-1.0.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for velocitybrain_client-1.0.1.tar.gz
Algorithm Hash digest
SHA256 4f1b803ac335f4cb0d10a6403ab870d8923162c1af905a55fa46800cc3044c39
MD5 4de67da4f21c3aa7f3d3678f07ea4c21
BLAKE2b-256 dbc38fa774e2d9c68ca2d842441901e55170a6f883875339b7bd442ac0589a35

See more details on using hashes here.

File details

Details for the file velocitybrain_client-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for velocitybrain_client-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3888b47ca28e6a54097e1226fdab4608aaf4b1b3e453e2b82bb0fd012c11943f
MD5 66b2201f5ebf32f04de591741c678487
BLAKE2b-256 f2efa0202ee200c0b188d744bcdc886528ebb6700908ee91154ff30efb170704

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