Hyphen
Log In

Tool Reference

Reference guide for Hyphen Model Context Protocol (MCP) tools covering projects, deployments, feature toggles, agent automations, and environment metadata.

This reference covers MCP tools for Hyphen projects, deployments, feature flags, Agent tasks, ENV metadata, and documentation. Your assistant selects tools for each request.

Table of Contents

Conventions

  • Organization scoped. Every tool operates within the organization resolved from your credential (or pinned in the server URL).
  • Pagination. List tools take page_num / page_size and return a { data, totalCount, totalPages } envelope.
  • Permission prompts. Tools that modify data are annotated as writes, and destructive operations — deletes, deployment run triggers, and the chat tools that drive the platform agent — carry a destructive hint, so MCP clients ask for your confirmation before running them.
  • Production gate. On top of client-side prompts, the server refuses a deployment run that targets a production-type environment unless the call sets acknowledge_production: true, which agents are instructed to do only after you explicitly confirm.

Context

Tool What it does
whoami The authenticated user, member, and organization for the session.
get_organization Details of the current organization.

Projects and Environments

Tool What it does
list_projects List the organization's projects.
get_project Fetch one project by ID or alternate ID.
create_project Create a project.
list_environments List a project's environments, including their types.

Apps

Tool What it does
list_apps List apps, optionally scoped to a project.
get_app Fetch one app.
create_app Create an app in a project.

Deployments

Observability and control for Hyphen Deploy.

Tool What it does
list_deployments List deployments with readiness (isReady, readinessIssues).
get_deployment Fetch one deployment.
get_deployment_metrics CPU, memory, requests-per-minute, and instance-count statistics per traffic region.
list_deployment_runs Run history with statuses (queued, running, succeeded, failed, …).
get_deployment_run One run with pipeline detail.
get_deployment_run_logs A run's pipeline log entries, for debugging failures.
start_deployment_run Start a run — each app's latest build by default, or pinned artifacts (build_id or a container image URI). Production-gated.
cancel_deployment_run Stop a run mid-flight.
rollback_deployment Redeploy the exact build artifacts of a previous successful run; the last known-good run is picked automatically when run_id is omitted. Production-gated.

Feature Toggles

Manage feature flags and their targeting.

Tool What it does
list_toggles List a project's toggles.
get_toggle One toggle with its targeting configuration.
create_toggle Create a toggle.
update_toggle Update a toggle's values or targeting.
delete_toggle Retire a toggle.
evaluate_toggle Evaluate a flag against the Horizon edge — the same answer a real user would receive. Auto-discovers your organization's public_… evaluation key when you don't pass one.

Toggle Segments

Tool What it does
list_toggle_segments List a project's segments.
create_toggle_segment Create a segment.
update_toggle_segment Update a segment's rules.
delete_toggle_segment Delete a segment.

Toggle Lifecycle Intelligence

Hyphen records every edge evaluation as telemetry; these tools turn it into flag hygiene.

Tool What it does
get_toggle_usage_summary Evaluation counts per project and environment (daily: true for a time series).
list_unused_toggles Flags older than 90 days whose evaluations have collapsed to a single constant value.
get_toggle_usage One flag's daily or raw evaluation telemetry.
get_toggle_insights Classifies a flag as dormant (no traffic), constant (traffic but no varying result), or active.

Audit Events

Tool What it does
search_events Search organization audit events for resource changes and access. Filter by event type, date, or referenced entity. Results include the actor, time, IP address, and location.

Agent Tasks and Runs

Schedule and inspect Hyphen Agent automations. Requires the agent entitlement.

Tool What it does
create_agent_task Schedule a StaleFeatureFlagCleanup, Optimizer, LogAnalysis, or ResourceCleanup task — one-shot or recurring via cron.
list_agent_tasks List scheduled tasks.
get_agent_task One task's configuration and state.
delete_agent_task Remove a scheduled task.
list_agent_task_threads Recent activity grouped by task, including pull requests the automations opened.
list_agent_task_runs Executions of one task.
list_runs Recent runs across tasks.
get_run One run's progress, findings, and output.
respond_to_run_input_request Answer a paused run's questions — runs in action_required are waiting on exactly that.

ENV Secrets (Metadata)

Tool What it does
list_dotenvs List ENV environments and their metadata.
get_app_dotenv One app environment's metadata — version, secret count, size.

📘 Metadata only, by design. ENV values are end-to-end encrypted with a key only you hold, so the server can never read or return secret values. Use the CLI (hx env pull) locally when you need them.

Platform Agent Chat

Drive Hyphen Agent chat sessions from your own assistant. Because the platform agent can create, modify, or delete organization resources server-side, these tools carry the destructive hint and prompt for permission.

Tool What it does
create_chat_session Start a chat session with the platform agent.
send_chat_message Send a message into a session.
respond_to_chat_input_request Answer the agent's structured confirmation or selection prompts.
list_chat_sessions List sessions.
get_chat_session One session's state.
get_chat_messages A session's message history.
close_chat_session Close a session when work is complete.

Utilities

Tool What it does
get_dockerfile_example A production-ready Dockerfile example for a language and framework (ASP.NET Core, Express, Fastify, Next.js, React).
get_dockerignore_example The matching .dockerignore example.
search_docs Search the live Hyphen documentation, so answers come from current docs instead of stale training data.
get_docs_page Fetch one documentation page.
get_migration_guide A step-by-step guide for migrating to Hyphen — see prompts and resources.