Skip to main content

CLI and MCP server for Voog CMS — Liquid templates, pages, products, ecommerce

Project description

voog-mcp

PyPI tests license: MIT python: 3.10 | 3.11 | 3.12

CLI and MCP server for Voog CMS — manage Liquid templates, pages, products, ecommerce settings, and redirects from your terminal or directly from Claude / any MCP client.

What is Voog?

Voog is a multilingual website builder and CMS with built-in ecommerce, used for content sites and small online stores. This package wraps its admin API so you can edit templates, pages, products, and redirects from your shell or an LLM agent.

Install

From PyPI:

pip install voog-mcp
# or, no install: uvx voog-mcp --help

Or directly from GitHub (latest unreleased main):

uvx --from git+https://github.com/runnel/voog-mcp.git voog --help

For development:

git clone https://github.com/runnel/voog-mcp
cd voog-mcp
python3.10 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

Configure

Run voog config init to interactively create the global config:

voog config init

This creates ~/.config/voog/voog.json with your tokens inline:

{
  "sites": {
    "mysite":   {"host": "mysite.com",   "api_key": "vk_..."},
    "client_a": {"host": "clienta.com",  "api_key": "vk_..."}
  },
  "default_site": "mysite"
}

Get a token from your Voog admin: Admin → API.

Shared / CI configs

If voog.json is checked into version control or shared across machines, keep the token out of the file by referencing an env var instead:

{
  "sites": {
    "client_a": {"host": "clienta.com", "api_key_env": "CLIENT_A_KEY"}
  }
}

Then put the token in ~/.config/voog/.env:

CLIENT_A_KEY=vk_...

Both forms can coexist per-site. When both api_key and api_key_env are set, the env-var wins if it's defined — so an inline value acts as a default that the deployment overrides.

Per-repo site selection

In a repo dedicated to one Voog site, drop a voog.json at the repo root to pin the site:

{"default_site": "mysite"}

The cwd-level voog.json deep-merges over the home config, with cwd winning per-key. Inside sites, the merge is per-site name — a cwd entry replaces the whole site definition (host + token), it does not merge individual fields. You can also redefine entire sites here (handy for client repos that should bring their own host/token without touching the home config):

{
  "sites": {
    "client_x": {"host": "clientx.com", "api_key": "vk_..."}
  },
  "default_site": "client_x"
}

Now voog pull / voog push from that directory always target the right site, even if the home default differs.

Note: voog-site.json from earlier versions still works but emits a DeprecationWarning. Replace it with voog.json containing {"default_site": "<name>"} for the same effect.

Use the CLI

voog --help                      # all commands
voog config list-sites           # show configured sites
voog --site mysite products      # list products on mysite
voog pull                        # download templates (uses cwd-level voog.json)
voog push layouts/Front\ page.tpl
voog redirects
voog config check                # verify all configured tokens
voog site-snapshot backup/       # full-site snapshot for diff/audit

Use as MCP server

Add to your Claude Code config (or any MCP client). The simplest setup uses the published PyPI package:

{
  "mcpServers": {
    "voog": {
      "command": "uvx",
      "args": ["voog-mcp"]
    }
  }
}

If you'd rather track unreleased main (e.g. for a fix that hasn't shipped yet), point uvx at the GitHub repo instead:

{
  "mcpServers": {
    "voog": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/runnel/voog-mcp.git", "voog-mcp"]
    }
  }
}

Every tool requires a site parameter. Start with voog_list_sites to discover what's configured:

voog_list_sites()
→ [{"name": "mysite", "host": "mysite.com"}, ...]

page_get(site="mysite", page_id=42)
→ {...}

Tools

Full endpoint coverage reference: docs/voog-mcp-endpoint-coverage.md

Group Tools
Sites voog_list_sites, voog_list_my_sites
Search voog_search
Pages pages_list, page_get, page_create, page_update, page_set_hidden, page_set_layout, page_set_data, page_delete_data, page_duplicate, page_delete
Articles articles_list, article_get, article_create, article_update, article_publish, article_set_data, article_delete_data, article_delete
Comments comments_list, comment_delete, comment_toggle_spam
Tags tags_list, tag_get, tag_delete
Layouts layouts_pull, layouts_push, layout_create, layout_update, layout_rename, layout_delete, layout_asset_create, layout_asset_update, layout_asset_delete, asset_replace
Texts / contents text_get, text_update, page_add_content, content_partial_update
Elements elements_list, element_get, element_definitions_list, element_create, element_update, element_move, element_delete
Products products_list, product_get, product_create, product_update, product_set_images, product_delete, product_duplicate, products_bulk_action
Categories categories_list, category_get, category_create, category_update, category_delete
Orders orders_list, order_get (read-only; PII-stripped by default, include_pii=true requires force=true)
Discounts discounts_list, discount_get, discount_create, discount_update, discount_delete
Cart rules cart_rules_list, cart_rule_get, cart_rule_create, cart_rule_update, cart_rule_delete
Shipping / payments shipping_methods_list, gateways_list
Ecommerce settings ecommerce_settings_get, ecommerce_settings_update
Multilingual languages_list, language_create, language_delete, nodes_list, node_get, node_update, node_move, node_relocate
Redirects redirects_list, redirect_add, redirect_update, redirect_delete
Site site_get, site_update, site_set_data, site_delete_data
Webhooks webhooks_list, webhook_create, webhook_update, webhook_delete
Snapshot pages_snapshot, site_snapshot
Read-only passthrough voog_admin_api_read, voog_ecommerce_api_read
Generic passthrough voog_admin_api_call, voog_ecommerce_api_call (GET deprecated — use the _read tools above)

What's NOT supported

voog-mcp covers content + ecommerce catalog management end-to-end as of v1.4. The following Voog API areas remain out of scope — drop down to the voog_admin_api_call / voog_ecommerce_api_call passthrough tools when you need them:

  • Order mutationorders_list / order_get are read-only typed tools (with PII stripping); creating / updating / cancelling orders goes via passthrough. Order writes carry finance / operations risk that a future release will design separately.
  • Cart readscart_rules_* tools cover cart-rule CRUD, but reading individual cart sessions (/carts) is passthrough-only.
  • element_definitions CRUDelement_definitions_list is wrapped; create / update / delete remain passthrough.
  • People / site_user admin — full passthrough.
  • Form definitions and form responses — passthrough.
  • Site favicons and bulk file imports — product image galleries are first-class via product_set_images; other multipart uploads go via passthrough.
  • Site creation — voog-mcp targets existing sites.

If you need any of these, open an issue — or a PR.

License

MIT

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

voog_mcp-1.4.1.tar.gz (328.2 kB view details)

Uploaded Source

Built Distribution

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

voog_mcp-1.4.1-py3-none-any.whl (204.0 kB view details)

Uploaded Python 3

File details

Details for the file voog_mcp-1.4.1.tar.gz.

File metadata

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

File hashes

Hashes for voog_mcp-1.4.1.tar.gz
Algorithm Hash digest
SHA256 00cbee678d3f83cc861af22dfeeeba4b4cb2354ca0a380d1fa0b68c239845cec
MD5 e5977566ea2e98985fe70e880760b143
BLAKE2b-256 5d635a88d3e33915eb448c074161638e0361a3e3e638abaf64bef9c307015206

See more details on using hashes here.

Provenance

The following attestation bundles were made for voog_mcp-1.4.1.tar.gz:

Publisher: publish.yml on runnel/voog-mcp

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

File details

Details for the file voog_mcp-1.4.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for voog_mcp-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f73a98538bd7c465dd727dee86f3d12bf416b3441fdd8e91056d0d6b17c4dbf0
MD5 a547723740051f7da7cc5e2af8e2456a
BLAKE2b-256 e45034844967f17ae2581864b995f17729ecc975229c084e9572354e45d878d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for voog_mcp-1.4.1-py3-none-any.whl:

Publisher: publish.yml on runnel/voog-mcp

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