The HyperAI MCP server exposes 31 tools across five feature groups. All tools run under your own account after OAuth sign-in, so results are scoped to the containers, projects, and datasets you can access. List tools return 30 items per page.

You normally don't call these tools yourself — your AI assistant picks them based on what you ask for. This page is a reference for understanding what the assistant can and cannot do.

User

Tools for querying your own account — profile, quota, billing, usage, and subscriptions. They always operate on the signed-in account and take no username parameter.

user_get_profile

Get your account profile: username, display name, email, registration date, roles, membership status, balance, and the organizations you belong to. An organization's name is what the username parameter of compute_list_jobs and compute_list_projects accepts. Useful for verifying the connection. For an organization's capability flags, seat quota, and members, use the org_get and org_list_members tools.

No parameters.

user_get_quota

Get your storage quota (used / total / remaining), prepaid compute minutes per resource type, and account limits such as the maximum number of containers, GPUs, datasets, and projects.

Quota is a prepaid balance, not a capability cap — zero remaining minutes for a resource does not mean it is unavailable; pay-as-you-go usage still charges your account balance.

No parameters.

user_list_transactions

List billing transactions — recharges, charges, subscription renewals, refunds, and transfers — newest first. Each amount carries its own currency.

Parameters:

• type — filter by direction: recharge (deposits, gifts, vouchers), spend (charges), refund, transfer (transfers between accounts), or all (default)
• page — page number

user_list_usages

List resource usage records, newest first. Compute records carry a duration; serving records are billed as (end − start) × replica count; storage records carry the size change that counts against your storage quota.

Parameters:

• page — page number

user_list_subscriptions

List your subscriptions across all categories — membership, storage expansion, prepaid compute, and organization seats — with plan, price per period, validity, and auto-renewal status. An active subscription with auto-renewal enabled is charged automatically at the end of each period.

Canceling a subscription is only possible in the HyperAI console, not through this tool.

No parameters.

user_get_spend_analysis_guide

Returns a guide for analyzing account spending. Assistants should read it before answering spending questions ("why did my balance drop", "what am I paying for"), so they collect the right data from the other user tools first.

No parameters.

Compute

Tools for working with compute containers and projects — the same objects you see in the Gear section of the console.

compute_list_jobs

List compute containers, newest first.

Parameters:

• username — optional; an organization you belong to (your organizations are listed by user_get_profile). Omit to list your own containers.
• status — running / succeeded / failed / cancelled / all (default all)
• q — substring match on container names
• page — page number

compute_list_projects

List projects.

Parameters:

• username — optional; an organization you belong to (your organizations are listed by user_get_profile)
• q — substring match on project names
• page — page number

compute_list_resources

List available compute resource tiers (GPU/CPU) with specs, whether your balance can afford each, and current load.

Parameters:

• username — optional

compute_list_plans

List billing plans: pay-as-you-go and time-boxed packages with durations and prices.

Parameters:

• resource — optional; a resource name from compute_list_resources

compute_list_runtimes

List available container runtime environments (images), excluding deprecated ones.

Parameters:

• username — optional

compute_get_job

Get full details of a container, including its access URL. Secret values are masked.

Parameters:

• job_id_or_url — a container ID or a console container URL

compute_get_job_metrics

Get summarized system and custom metrics of a container (latest / min / max / average).

Parameters:

• job_id — container ID

compute_get_project

Get project details plus its container execution history.

Parameters:

• project_id_or_url — a project ID or a console URL
• status — filter the execution history: running / succeeded / failed / cancelled / all
• page — page number

compute_get_job_readme

Read a container's README as rendered HTML.

Parameters:

• job_id_or_url — a container ID, a project ID, or a console URL

compute_get_job_notebook

Read a container's notebook content.

Parameters:

• job_id_or_url — a container ID, a project ID, or a console URL

compute_get_create_job_guide

Returns the recommended step-by-step workflow for creating a container (billing, data binding, environment variables, ports). Assistants should read this before calling compute_create_job.

No parameters.

compute_create_job

Create a new workspace container.

Parameters:

• resource — required; a resource name from compute_list_resources
• runtime — required; a runtime name from compute_list_runtimes
• project_id / new_project_name — exactly one of the two: create in an existing project, or create a new project
• description — optional container description
• plan_id — optional; a time-boxed billing plan from compute_list_plans. Omit for pay-as-you-go.
• auto_renew — whether a time-boxed plan renews automatically (default true)
• idle_timeout_minutes — auto-stop after idle time (default 30, 0 disables)
• env — environment variables, a list of {name, value, secret}
• data_bindings — data to mount, a list of {source, mount_path, writable}
• ports — custom port mappings, a list of {port, name}

A few rules the tool enforces, matching the console's behavior:

• Data bindings mount at /input0 through /input4 (read-only sources such as datasets and models) and /output (only a previous container output of the form <owner>/jobs/<job-id>/output can be bound there). See Data Binding.
• Environment variables must not use the reserved OPENBAYES_ prefix, and names containing TOKEN / SECRET / KEY / PASSWORD must be marked as secret. See Environment Variables.
• Port 8080 is reserved for the container's built-in service and cannot be mapped. See Custom Port Mapping.
• The chosen resource must be affordable with your current balance and not at full load, and the chosen billing plan must belong to that resource.

compute_stop_job

Stop a running container.

Parameters:

• job_id — exact container ID; URLs are rejected

compute_restart_workspace

Restart a stopped workspace container with its previous configuration.

Parameters:

• job_id — container ID

compute_update_project

Update project settings: name, description, idle timeout, and tags.

Parameters:

• project_id_or_url — a project ID or a console URL
• name — optional new name
• description — optional new description
• idle_timeout_minutes — optional; applies project-wide, 0 disables
• add_tags / remove_tags — optional tag lists; tags are validated against the platform catalog

compute_update_job_ports

Add or remove custom port mappings on a container. Port 8080 is reserved and cannot be mapped.

Parameters:

• job_id — container ID
• add_ports — a list of {port, name}
• remove_ports — a list of port numbers to remove

Resources

Tools for discovering public content on the platform.

resources_search_public_projects

Search public projects (tutorials and community projects), filterable by tags. A public project can be cloned as the starting point of a new container.

Parameters:

• q — search keywords
• tags — a list of tag names to filter by
• page — page number

Dataset

Tools for managing datasets and models — searching, inspecting, creating entries, updating metadata, and deleting. Uploading data is not covered here: that happens in the web console or with the bayes CLI.

dataset_search

Search datasets and models — your own and public ones — in one call. Each result includes the binding name to use as a data_bindings source in compute_create_job.

Parameters:

• q — search keywords
• category — dataset / model / all (default all)
• username — optional; search under an organization instead of your own account
• tags — a list of tag names to filter public results by; tags are a platform-controlled vocabulary matched exactly
• page — page number for your own results
• public_page — page number for public results

dataset_get

Get the full details of a dataset or model in one call: metadata, owner, permissions, every version, and the selected version's README as rendered HTML. Each version carries the binding name to use as a data_bindings source in compute_create_job; the top-level size spans all versions.

Parameters:

• dataset_id_or_url — a dataset/model ID or a console URL; a trailing version segment in the URL is honored
• version — optional version number; overrides the version in the URL

dataset_create

Create a new, empty dataset or model entry — a metadata shell with no versions and no data. Every call creates a new entry, so check with dataset_search first to avoid duplicates.

Parameters:

• name — required entry name
• kind — dataset / model (default dataset)
• description — optional description
• tags — optional tag list; tags must be existing names from the platform tag catalog (case-sensitive)
• username — optional; create under an organization instead of your own account

dataset_update

Update a dataset's or model's metadata: name, description, kind, and tags. Pass only the fields to change. Organization-owned entries work directly — the owner is resolved automatically.

Parameters:

• dataset_id_or_url — a dataset/model ID or a console URL
• name — optional new name
• description — optional new description
• kind — optional; change between dataset and model
• add_tags / remove_tags — optional tag lists; tags are validated against the platform catalog before anything is written

dataset_delete

Permanently delete a dataset or model, including every version and all uploaded data. After deleting, the tool re-reads the entry to verify it is gone.

Parameters:

• dataset_id_or_url — a dataset/model ID or a console URL
• confirm_name — must match the entry's exact current name

Org

Tools for querying the organizations you belong to. All three are read-only — inviting members, changing roles, and leaving an organization are console operations. An organization's ID doubles as the username parameter of compute_list_jobs, compute_list_projects, and dataset_search.

org_list

List the organizations you belong to, with your role in each (OWNER / MEMBER / PENDING) and per-organization capability flags such as canCreateProject and canCreateInvitation. Whether you can do something in an organization is answered by the capability flags, not the role.

No parameters.

org_get

Get one organization's details: profile (display name, description, type, locked state), seat quota (used / total / remaining), and your capability flags in that organization.

Parameters:

• org_id — the organization's ID, not its display name

org_list_members

List an organization's members, 30 per page: username, display name, role, and join date, plus whether you can remove each member or change their role. Rows with the PENDING role are outstanding invitations.

Parameters:

• org_id — the organization's ID
• page — page number