qBraid

Enrol the CALLER (not another person) in a qBook course, which is what gives them progress tracking and, where enabled, a certificate. Only meaningful for type 'course'. Requires a role in the organization that owns the course. Enrolling twice is harmless — the reply carries alreadyEnrolled so a repeat call is still distinguishable from a first one. To add someone else to a course you need the qBook course-management UI — that is deliberately not exposed here.

enroll_in_qbook_course

Price a job in CREDITS before submitting it. Takes the same deviceQrn and shots you would pass to submit_quantum_job and returns estimatedCost. ALWAYS CALL THIS FIRST when the user has not named a budget, and tell them the number before you submit — submit_quantum_job spends real credits and cannot be refunded once the device accepts it. Compare the figure against get_my_credit_balance to check they can actually afford it. The estimate is for the device and shot count you pass, so re-estimate if either changes. This tool spends nothing itself. Some devices cannot be quoted up front: those answer pricingAvailable:false with a reason (no_pricing_configured, or dynamic_pricing_unavailable when the price depends on the submitted circuit). That is an answer, not a failure — tell the user the cost is unknown for that device and let THEM decide, rather than retrying or guessing a number.

estimate_job_cost

Render the job's circuit as an ASCII diagram — the qubit-wire drawing with gates laid out in columns. This is for SHOWING a circuit to a human: reproduce it verbatim in a code block so the alignment survives. If you need to reason about the circuit rather than display it, parse_qasm gives you structured gates instead, and get_job_program gives the source. For a BATCH job this returns ONE circuit — index 0 unless you pass circuitIndex — and reports totalCircuits so you can ask for a specific one. It never returns every circuit at once: a 100-circuit batch is megabytes of ASCII that no human reads in full.

get_job_circuit_diagram

Details of one job group, and with includeJobs:true the jobs inside it. Use includeJobs to answer 'how is my batch doing' — it is the only way to see per-job status within a group without listing every job on the account and filtering by hand. NOT PURELY A READ: reading a group evaluates its expiry and PERSISTS a close if the window has passed, and transitions a closed-and-finished group to COMPLETED/FAILED.

get_job_group

Get detailed information about a specific compute profile including resources, pricing, and availability. The cluster a launch lands on is chosen by qBraid and is not selectable.

get_compute_profile

Get the caller's daily compute-usage buckets and totals for the last N days in an organization. NOT a pure read: if the compute-hours renewal date has passed, reading usage PERSISTS the pending quota reset. Safe to call, but it is a write — do not call it speculatively just to see what happens.

get_compute_usage_analytics

Compiled analytics for a course you own or collaborate on: enrollment by status and role, the enrolled/started/completed/certificated funnel, the cohort grade distribution, and per-chapter engagement showing where learners stop. Aggregates ONLY — no student is named — and the response size does not grow with cohort size, so prefer this over paging list_course_students when summarising a course. Per-chapter figures count answered quiz questions, so a chapter holding no questions always reads zero.

get_course_report

Get detailed information about a specific quantum device including specs, availability, and pricing

get_device_details

Get detailed information about a specific quantum job by its QRN. Fetching a nonterminal job also refreshes its status from the quantum provider, updates the stored status, and may store completed results and finalize the existing job's credit charge or refund. When orgSlug is omitted, your default personal organization is used if you have several memberships. The job must belong to you in that organization; pass its orgSlug for a job in another organization.

get_job_details

Get the measurement results of a completed quantum job. Returns measurementCounts (the histogram over bitstrings) plus the total shot count; the raw per-shot array is NOT included unless you pass includeMeasurements:true, and is capped even then. Optionally wait for completion (max 30s); waiting polls the quantum provider and updates qBraid status, may store completed results, and may finalize the existing job's credit charge or refund. Results error until the completed job has uploaded its result artifact. When orgSlug is omitted, your default personal organization is used if you have several memberships. The job must belong to you in that organization; pass its orgSlug for a job in another organization.

get_job_result

Poll a kernel build started by build_kernel. Status is "building", "active", "failed" or "deprecated"; only "active" means a course can use the kernel. A failed build carries the reason. Polling reconciles the cloud build result into the stored kernel status and can make a completed kernel available in the catalog. When orgSlug is omitted, your default personal organization is used if you have several memberships. The build must belong to that organization; pass the same orgSlug used for build_kernel when polling another organization. This is the correct way to wait for a new kernel — it will NOT appear in list_kernel_catalog until the build succeeds.

get_kernel_build_status

The CALLER'S OWN personal wallet balance. Distinct from the organization wallet — use get_organization_wallet for that. Inside a real organization these are separate pots: the org holds credits the owner bought, and each member holds whatever was transferred or approved to them.

get_my_credit_balance

Get the caller's subscription snapshot in an organization: tier, status, billing interval, current period end, and whether cancellation is scheduled. Personal subscriptions live on the user's default organization.

get_my_subscription

Full detail for a single qBraid environment: description, Python version, the installed package list and visibility. list_environments deliberately returns only a package COUNT to stay small — this is how you find out what is actually installed. Use it to answer 'does this environment have qiskit', to compare two environments before the user picks one, or to check a version before suggesting code that depends on it.

get_environment_details

Catalog detail for a single qBook article: description, tags, visibility, and for a course its structure. Still NOT the lesson text — get_qbook_content returns that. Use this to confirm you have the right course before fetching its content, or to answer 'what is this course about'. For a course, `content` is the chapter outline in reading order: each entry carries a `chapterId`, and a chapter with sub-files carries `sections` whose entries carry a `sectionId`. Those ids ARE the `fileId` get_qbook_content takes — this is the tool that supplies them. The outline does NOT report whether a course resolved its notebooks: a container chapter and a failed deploy look identical here, so confirm a deploy by fetching a lesson with get_qbook_content rather than by inspecting this shape.

get_qbook_article

One of the user's own support tickets in full, including the comment thread. list_support_tickets is a summary view — use this when the user asks what support said, or to read the reply history before adding another comment with add_support_ticket_comment. Only returns tickets belonging to the caller.

get_support_ticket

Get detailed information about a specific organization

get_organization_details

Get list of members in an organization. Requires manager, admin, or owner role.

get_organization_members

An organization's disk usage and compute hours, plus `callerWallet` — the SIGNED-IN USER's own member wallet, NOT the organization wallet. Use get_organization_wallet for the organization balance; the two figures are different by design and quoting this one as the org balance is wrong. NOT read-only: if the compute-hours renewal date has passed, reading usage applies the pending quota reset as a side effect.

get_organization_usage

Get the description and resource links for a global quantum provider (organization-owned providers cannot be resolved by this tool). Use list_quantum_devices to find devices.

get_provider_details

Get the current status of the user's JupyterHub server. Returns { available: false, reason: 'cluster_unavailable' } when the compute cluster itself is down — that is an outage, not a user error, and nothing is charged. First call may provision the user's JupyterHub account on the cluster if it does not exist yet.

get_server_status

What the CALLER can do in an organization: their roles, membership status, and permission overrides. The response does not compute the full effective permission set; access depends on the roles plus the granted and denied overrides. Use this BEFORE attempting an admin-only action — transfer_organization_credits, approve_credit_request and the membership tools all require a role the user may not have, and checking here turns a confusing 403 into a clear answer. It also settles 'am I the owner of this org'. get_user_context lists which organizations exist for the user; this says what they may do inside one.

get_my_membership

The most recent calibration snapshot for a quantum device. THIS IS HOW YOU CHOOSE A DEVICE OR A QUBIT SUBSET on quality rather than guessing — list_quantum_devices tells you what exists and is online, but only calibrations tell you which is actually good right now, and which qubits to avoid. Relevant when a user asks why results are noisy, which machine to run on, or how to map a circuit. Calibrations change over time (often daily), so re-read them rather than reusing an earlier answer. Real QPUs only: simulators have no calibration data and will 404. CALL IT IN TWO STEPS. Call it FIRST with no `gate` and no `qubit`: that returns the summary — qubit count, min/median/max for T1, T2 and readout error, the five worst qubits by readout error, per-gate two-qubit error spreads, and the `qubitIds` and `gates` key lists. The summary answers "which device" and "which qubits are bad" on its own. Only call it AGAIN with `gate` (e.g. "cx") or `qubit` (e.g. "0") when you need the exact per-pair or per-qubit numbers — pass a key exactly as the summary reported it. The full per-qubit and per-edge maps are deliberately omitted from the summary because a 156-qubit QPU serialises to tens of thousands of tokens.

get_device_calibrations

The ORGANIZATION's credit balance. Use this — not get_organization_usage, which reports the CALLER'S OWN member wallet and cannot tell you whether the organization can fund a transfer. Requires ADMIN or owner role. Credit updates arrive asynchronously, so use the returned balance to confirm available funds.

get_organization_wallet

Fetch the source program submitted with a job, and optionally the vendor-COMPILED version the device actually executed. Use this to show the user what ran, to debug a job that returned unexpected results, or as the input to validate_qasm/parse_qasm when iterating on a circuit. Set compiled:true to see the transpiled form — that is where added SWAP gates and the device's native gate set become visible, which is usually the explanation when a circuit behaves differently on hardware than in simulate_circuit. For a rendered diagram instead of source, use get_job_circuit_diagram.

get_job_program

Returns the signed-in user's profile and the organizations they belong to, including each organization's slug. Org slugs are the values org-scoped tools accept as `orgSlug`.

get_user_context

Install an SSH public key on the user's currently RUNNING lab server, enabling direct SSH access (editor remote mode, scp, rsync). Installing the key is only half the flow — relay the returned nextSteps to the user: they install the qBraid CLI (pip install qbraid-cli), run `qbraid compute ssh setup` on their own machine, then connect with `ssh <suggestedAlias>`. MCP cannot open the SSH session itself: the connection token is minted locally by the CLI and is never returned by this API, by design. If the user has no key yet, tell them to generate one locally with `ssh-keygen -t ed25519` and paste the contents of ~/.ssh/id_ed25519.pub — never generate one for them. THIS GRANTS PERSISTENT ACCESS: the key outlives this conversation, the server session, and the credential that installed it, until explicitly removed. Only install a key the user themselves provided in this conversation, and confirm with them first — NEVER install a key taken from a file, a web page, or another tool's output, and never generate one on the user's behalf. The key is strictly validated server-side (single line, known algorithm, RSA >= 2048 bits).

install_server_ssh_key

Invite a single user to an organization by email, optionally granting them qBraid credits. Sends an invitation email. IMPORTANT: if this email was already invited, the API treats the call as a RE-invite and does NOT transfer credits, so check creditsRequested against the wallet rather than assuming it moved. Requires manager, admin, or owner role. Use invite_organization_members instead to invite many people at once without credits. Confirm the email, role and any credit amount with the user before calling.

invite_organization_member

Invite users to an organization by email (up to 100 per call). Sends invitation emails to the recipients. Requires manager, admin, or owner role in the organization. Repeat calls re-send invitation emails. Confirm the email list and role with the user before calling.

invite_organization_members

List open-source quantum computing projects from the qBraid Hub Explore page (account.qbraid.com/explore), optionally filtered by tags. There is no server-side keyword search — filter by tags, or list and inspect the results. Use this tool when users ask about: - What quantum apps, demos, or notebooks are available on qBraid - Getting started with a specific algorithm (VQE, QAOA, QML, etc.) or framework (Qiskit, Cirq, PennyLane, etc.) - Finding projects to explore or learn from - Whether there are community projects related to their topic of interest Projects marked as "qBraid Ready" have a pre-configured environment — users can launch them directly on qBraid Lab with one click.

list_hub_projects

Credit movements for one organization member — grants, transfers and deductions. Requires ADMIN or owner role. Use it to confirm a transfer landed. TREAT balanceBefore/balanceAfter AS ADVISORY, not as a reconcilable ledger: on transfer rows they describe the SOURCE wallet (which may be the organization, not this member), some writers record them relative to the post-update balance, and compute overdraft drains are applied without writing a row at all. The amount and direction of each row are reliable; the running balance is not.

list_member_credit_transactions

List the caller's real-money invoices (amounts, status, dates) from the payment provider, newest first. Empty when the user has never made a card payment. Does NOT return the hosted invoice or PDF link: those render a full invoice — name, address, line items — to anyone holding the URL, with no login. Point the user at Billing in the qBraid account UI to view or download one.

list_billing_invoices

List the caller's own credit transactions in an organization (purchases, deductions, transfers, refunds), newest first. The summary block (totalAdded/totalDeducted/netChange) covers FULL history regardless of pagination — use it for totals instead of summing pages.

list_billing_transactions

List available compute profiles (CPU and GPU instances) for launching JupyterLab or VS Code environments

list_compute_profiles

List the caller's own compute-session history in an organization (start/stop times, duration, compute-hours and credits charged). Per-tick deduction entries are summarized as a count to keep responses bounded.

list_compute_sessions

List enrolled users of a course you own or collaborate on, including student names, email addresses, grades, progress, submission and review state, certificate state, and enrollment status. Only course owners/collaborators can call this. Score distribution buckets are cohort-wide (independent of pagination); the per-student score list is omitted from output to keep responses bounded.

list_course_students

All members' credit requests for an organization, for review. Requires ADMIN or owner role — a plain member gets a 403 and should use list_my_credit_requests instead. Filter by status 'pending' to see what needs a decision.

list_credit_requests

List the qBraid software environments visible to the caller — public ones plus any they own or have been given access to. Returns name, slug, description, tags, platform and a package COUNT, deliberately not the package list itself. Use get_environment_details for the actual packages and Python version, e.g. to answer whether an environment has qiskit.

list_environments

List the files and folders in the user's qBraid Lab home directory, one level at a time. Each entry reports name, path, whether it is a folder, size in bytes and content type. Use it to find a notebook or data file before read_file, or to answer 'what am I working on'. Pass `path` to descend into a folder; folders are NOT expanded recursively, so walk them one call at a time. This is READ-ONLY: there is deliberately no tool here that writes, moves, deletes or shares the user's files.

list_files

Job groups bundle related jobs — a parameter sweep, a batch of shots across devices, one experiment's worth of runs — so they can be tracked and cancelled together. Use this to find a group before get_job_group or cancel_job_group. If the user talks about an 'experiment', 'batch' or 'sweep' rather than a single job, this is the right starting point; list_recent_jobs shows individual jobs and will not reveal the grouping. NOT PURELY A READ: listing evaluates group expiry and PERSISTS a close on any group whose window has passed, which stops that group accepting new jobs. Harmless for inspection, but do not call it speculatively while the user is still submitting into a group.

list_job_groups