Skip to main content

DEPRECATED — use `bithuman mcp` in the bitHuman CLI. MCP server for the bitHuman AI avatar platform.

Project description

bitHuman MCP server

[!IMPORTANT] Deprecated — use the bitHuman CLI instead. This server is now built into the bithuman CLI: run bithuman mcp. It exposes the same tools (identical names) plus local ones (version, doctor, inspect_model, list_showcase), so you install one tool. Migrate your MCP client config:

{ "mcpServers": { "bithuman": { "command": "bithuman", "args": ["mcp"] } } }

Install the CLI: brew install bithuman (macOS) or the universal installer (macOS + Linux) — see the CLI README. This bithuman-mcp package will receive no further updates.

A Model Context Protocol server that exposes the bitHuman avatar platform as tools any MCP-capable AI agent can call — Claude Desktop, Claude Code, Cursor, and others.

It's a thin, fully-documented wrapper over the public REST API (https://api.bithuman.ai). Every tool maps to one documented endpoint; see the API docs and the OpenAPI spec.

Tools

The server exposes 21 tools, each mapping to one documented REST endpoint:

Tool What it does
validate_api_secret Check the API secret is valid (free).
get_credit_balance Current credits, plan, and minutes estimate.
get_usage Usage/metering history (paginated, date-filterable).
list_voices Built-in (M1–M5 / F1–F5) and custom TTS voices.
text_to_speech Synthesize speech → a WAV file.
generate_agent Create an avatar agent from a prompt / image / video / audio.
get_agent_status Poll agent generation progress.
get_agent Fetch an existing agent's details.
list_agents List your agents, newest first (paginated).
update_agent_prompt Change an agent's system prompt.
delete_agent Permanently delete an agent you own.
agent_speak Make a live agent speak text in its active sessions.
add_agent_context Silently inject knowledge into a live agent.
get_dynamics List an agent's gesture animations.
generate_dynamics Generate new gestures (wave, nod, laugh, idle…).
create_embed_token Mint a 1-hour JWT to embed an agent on a website.
upload_file Upload an asset (URL or local file) → CDN URL.
create_webhook / list_webhooks / delete_webhook / test_webhook Manage signed event webhooks (agent.ready / agent.failed).

Setup

You need an API secret from the Developer Dashboard.

Published on PyPI as bithuman-mcp. The easiest way to run it is with uvx (recommended for MCP clients), or pip install bithuman-mcp.

BITHUMAN_API_SECRET=sk_... uvx bithuman-mcp

Use with Claude Desktop / Claude Code

Add it to your MCP client config. For Claude Code:

claude mcp add bithuman \
  -e BITHUMAN_API_SECRET=sk_your_secret \
  -- uvx bithuman-mcp

For Claude Desktop (claude_desktop_config.json) or any client that takes a JSON server block:

{
  "mcpServers": {
    "bithuman": {
      "command": "uvx",
      "args": ["bithuman-mcp"],
      "env": { "BITHUMAN_API_SECRET": "sk_your_secret" }
    }
  }
}

Configuration

Env var Default Purpose
BITHUMAN_API_SECRET (required) Your API secret. Never logged.
BITHUMAN_API_BASE https://api.bithuman.ai API origin.
BITHUMAN_MCP_TRANSPORT stdio stdio or streamable-http.
BITHUMAN_MCP_TIMEOUT 120 Per-request timeout (seconds).

Notes

  • Async work: generate_agent and generate_dynamics return immediately with a processing status. Poll get_agent_status / get_dynamics until ready (generation takes 2–5 minutes).
  • Credits: generate_agent (~250 credits) and text_to_speech consume credits. Check get_credit_balance first if cost matters.
  • Errors: non-2xx responses come back as a structured {error, status_code, body, hint} object. The error catalog is at https://docs.bithuman.ai/api/errors.

License

Apache-2.0.

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

bithuman_mcp-0.3.0.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

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

bithuman_mcp-0.3.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file bithuman_mcp-0.3.0.tar.gz.

File metadata

  • Download URL: bithuman_mcp-0.3.0.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bithuman_mcp-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ef9c72b43c4af420a3c6de32c4dc554e4d43d1e1693dab44b3ec5fc272d4f600
MD5 55b765dadc7d33be913282f0f51c1422
BLAKE2b-256 a51d031c785b67f6e893f6c2dd972f22622b07e532bdd8b852a6d12b83df6df0

See more details on using hashes here.

Provenance

The following attestation bundles were made for bithuman_mcp-0.3.0.tar.gz:

Publisher: publish-mcp.yml on bithuman-product/bithuman-sdk-public

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bithuman_mcp-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: bithuman_mcp-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bithuman_mcp-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 432898fd0b6743511b2adc4b29df853bc0cd63f47581a8d5c3336a7987e8be7d
MD5 60d8196fd52b8147e8f793fe7b3c1cbf
BLAKE2b-256 2216d81d50d79118f7072ca90956d0b54fdcb1a0f5f9595629f771cff02d4d85

See more details on using hashes here.

Provenance

The following attestation bundles were made for bithuman_mcp-0.3.0-py3-none-any.whl:

Publisher: publish-mcp.yml on bithuman-product/bithuman-sdk-public

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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