Skip to main content

Official CLI, Python client, and MCP server for Hypertxt

Project description

Hypertxt Python

The official Python client, command-line interface, and MCP server for Hypertxt.

Use it to:

  • inspect account credits, projects, article templates, and articles;
  • retrieve, generate, export, review, archive, or publish articles;
  • query synchronized or live Google Search Console performance;
  • give MCP-compatible agents a deliberately scoped content-operations toolset.

Install

Install the CLI and MCP server into an isolated environment:

pipx install hypertxt

Or run the MCP server without a permanent install:

uvx --from hypertxt hypertxt-mcp

Python applications can install it with:

python -m pip install hypertxt

Authenticate

Create a named, revocable key in Hypertxt → Account → Automation. Keep it out of source control and chat transcripts:

export HYPERTXT_API_KEY="htx_replace_with_your_key"
hypertxt status
hypertxt projects

The client uses https://app.hypertxt.ai by default. Set HYPERTXT_API_URL only when testing against another Hypertxt deployment.

CLI examples

# Inspect
hypertxt status
hypertxt articles list --project-id 12 --status awaiting_review
hypertxt articles get 451

# Query GSC
hypertxt gsc query \
  --project-id 12 \
  --group-by query \
  --query-contains "mcp" \
  --start-date 2026-07-01 \
  --end-date 2026-07-25

# Generate after checking credits
hypertxt articles generate \
  --project-id 12 \
  --workflow-id 8 \
  --title "How editorial teams use MCP" \
  --keyword "MCP content workflow"

# Record editorial approval, then create a destination draft
hypertxt articles state 451 reviewed
hypertxt articles publish 451 --integration-id 9 --publish-status draft

Pass --json before the command for machine-readable output.

MCP

Start the stdio server:

hypertxt-mcp

Minimal MCP configuration:

{
  "mcpServers": {
    "hypertxt": {
      "command": "uvx",
      "args": ["--from", "hypertxt", "hypertxt-mcp"],
      "env": {
        "HYPERTXT_API_KEY": "${HYPERTXT_API_KEY}"
      }
    }
  }
}

The server exposes read tools separately from actions that spend credits, change editorial state, refresh GSC, or publish. Agents should inspect first and obtain approval before calling mutating tools.

Client-specific setup and downloadable prompts:

OpenClaw skill

Install the companion portable Hypertxt skill from its public repository:

openclaw skills install \
  git:simplebytes-com/hypertxt-openclaw@main \
  --as hypertxt

Configure the MCP server separately so the skill has tools to call. Start with the read-only tool filter in the OpenClaw guide, then enable generation, state changes, GSC refreshes, and publishing when you want the agent to perform those actions.

Python

from hypertxt import HypertxtClient

with HypertxtClient() as client:
    status = client.account_status()
    articles = client.list_articles(project_id=12, status="awaiting_review")

Development

python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
ruff check src tests
mypy src
pytest -q
python -m build

Security

  • Use a different named key for every client or machine.
  • Never paste an htx_… key into an LLM conversation.
  • Prefer environment or secret configuration over command arguments.
  • Inspect the full article before changing state or publishing.
  • Make generation and live publishing explicit.

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

hypertxt-0.1.0.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

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

hypertxt-0.1.0-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file hypertxt-0.1.0.tar.gz.

File metadata

  • Download URL: hypertxt-0.1.0.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for hypertxt-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c654f46ece615419c0a3aa0624a4b1d1271e7b44b8ebecf393dc0f58d7cf2946
MD5 d6db84107de2363b6d8c3b4e57f0eea7
BLAKE2b-256 a99d1fc5c1107fd3c1810d397091e8aad281a6c5ab969b332337105f3f4d010f

See more details on using hashes here.

Provenance

The following attestation bundles were made for hypertxt-0.1.0.tar.gz:

Publisher: publish.yml on simplebytes-com/hypertxt-python

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

File details

Details for the file hypertxt-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hypertxt-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for hypertxt-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e164d3f0222519251921561c4243df97a0d7f08ad435ee79d10108bd18ba6dc
MD5 6e9973c9f5b56d2033d55e36aa498e54
BLAKE2b-256 4d2daa82f4b66931fa3167e2a302eea0fea36a6d5e855ee47578323e61681002

See more details on using hashes here.

Provenance

The following attestation bundles were made for hypertxt-0.1.0-py3-none-any.whl:

Publisher: publish.yml on simplebytes-com/hypertxt-python

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