← Documentation home
/hyax-api/mcp

Available MCP tools

30 tools covering team stats, posts, people, products, email marketing, automations, community, and media uploads. All are team-scoped via the API key. Use tools/list for live schemas.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Example response

Shape varies by data; values are illustrative.

Team
  team_summary          — Content counts (posts, people, products, etc.)

Posts
  posts_list            — List posts (status, postType, search, slug filters)
  posts_get             — Get post by ID or slug (includes content)
  posts_update          — Update title, content, status, tags, pricing, etc.
  posts_archive         — Archive a post
  posts_delete          — Permanently delete a post

People
  people_list           — List CRM contacts (category, tag, search filters)
  people_get            — Get person by ID
  people_get_by_email   — Look up person by email
  people_add            — Create or return existing person
  people_update         — Update profile fields
  people_delete         — Delete person
  people_add_tags       — Add tags (by email or personId)
  people_remove_tags    — Remove tags (by email or personId)

Products
  products_list         — List products (type, active, archived, search)
  products_get          — Get product by ID
  products_update       — Update title, pricing, active status, etc.

Email
  email_list_broadcasts — List broadcasts
  email_get_broadcast   — Get broadcast/email by ID
  email_list_sequences  — List drip sequences
  email_get_sequence    — Get sequence with emails and triggers
  email_send            — Send transactional email
  email_enroll_in_sequence — Enroll subscriber in a sequence

Automations
  automations_list      — List workflows
  automations_get       — Get automation with nodes and edges
  automations_create    — Create new automation (DRAFT)
  automations_update    — Update name or description
  automations_toggle    — Activate or pause

Community
  community_list_categories — List forum categories and forums
  community_list_forums     — List forums
  community_list_threads    — List threads
  community_get_thread      — Get thread with replies
  community_get_settings    — Get community access settings

Media
  media_upload_from_url     — Upload an image from a URL (http/https or data:image base64) and return the CDN URL