---
title: "MCP Server | Jetstack AI Docs"
description: "Connect Claude, ChatGPT, Cursor or another MCP client to Jetstack AI to browse portals, import and deploy assets, run audits and work with Projects."
url: "https://jetstack.ai/docs/developers/mcp/"
---

# MCP Server

The Jetstack MCP server lets an AI assistant use your Jetstack AI account through the [Model Context Protocol](https://modelcontextprotocol.io). Your assistant can then do the same things the [REST API](https://jetstack.ai/api) does.

|                     |                                                               |
| ------------------- | ------------------------------------------------------------- |
| **Server URL**      | `https://mcp.jetstack.ai`                                     |
| **Also answers at** | `https://mcp.jetstack.ai/mcp`, for clients that expect a path |
| **Transport**       | Streamable HTTP (remote server)                               |
| **Sign-in**         | OAuth, using a Jetstack access token                          |

Every tool calls the Jetstack REST API with your access token. An assistant can only do what that token’s scopes allow.

## Before You Start

You need a Jetstack access token.

1. In the Jetstack app, go to **Settings → Access Tokens**.
2. Create a token. Pick the scopes the assistant needs. See [Scopes](https://jetstack.ai/docs/developers/mcp/#scopes) below.
3. Copy the token. It starts with `jsai_` and is shown only once.

For more on tokens and scopes, see [Authentication](https://jetstack.ai/docs/developers/authentication).

## Connect Your Client

Any MCP client that supports remote HTTP servers with OAuth can connect. Add the server URL, and the client opens the Jetstack sign-in page.

- [Claude](https://jetstack.ai/docs/developers/mcp/#tab-panel-0)
- [Claude Code](https://jetstack.ai/docs/developers/mcp/#tab-panel-1)
- [ChatGPT](https://jetstack.ai/docs/developers/mcp/#tab-panel-2)
- [Cursor](https://jetstack.ai/docs/developers/mcp/#tab-panel-3)
- [Other clients](https://jetstack.ai/docs/developers/mcp/#tab-panel-4)

Add Jetstack as a custom connector in Claude (web or desktop).

1. Open **Settings → Connectors**.
2. Choose **Add custom connector**.
3. Name it `Jetstack AI` and enter `https://mcp.jetstack.ai` as the URL.
4. Select **Connect**. Claude opens the Jetstack sign-in page. Complete [Sign In](https://jetstack.ai/docs/developers/mcp/#sign-in).

Custom connectors are available on Claude plans that support them. On Team and Enterprise plans, an owner may need to add the connector for the organisation first.

## Sign In

The Jetstack sign-in page asks for two values.

| Field            | What to enter                                                                                                                                                          |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Instance ID**  | Enter `default`. If your organisation runs on a dedicated Jetstack instance, paste the Instance ID shown in **Settings → Access Tokens → Connection Details** instead. |
| **Access Token** | Your `jsai_…` token.                                                                                                                                                   |

Select **Connect**. Jetstack checks the token, then sends you back to your client. The tools are ready to use.

- **Your token is never shown to the AI assistant.** The client holds a session that Jetstack issues, not your token.
- **Revoking the token ends access.** Tool calls fail as soon as the token is revoked in Jetstack, and the session closes at its next hourly renewal.
- **A session lasts 30 days.** After that, your client asks you to sign in again.

Create a separate token for each client you connect. You can then see which one made a change, and revoke one without affecting the others.

## Scopes

Each tool needs a scope on your token. If the token is missing it, the tool returns an error that names the scope it needs.

- **Read-only** covers listing portals, library assets, modules, tasks, audits and Projects. It doesn’t include browsing HubSpot.
- **Operator** adds browsing, importing and deploying HubSpot assets, and creating and running audits.
- **Projects write scopes** (`projects:write`, `projects:chat`, `projects:generate`, `projects:admin`) are added one by one.
- **`projects:deploy` and `projects:billing` are never part of a preset.** Add them on purpose, only to tokens that should deploy Projects work to HubSpot or buy credits.

Tools that import, deploy, run audits, or generate, repair, restore and retire Projects assets start real work. Deploys write to the target HubSpot portal, and Projects generation spends credits. Give these scopes only to tokens that need them, and keep your client’s tool-approval prompts turned on so you confirm each call.

## Example Prompts

- “List my connected portals, then show the workflows in the Acme production portal.”
- “Find the best MQL workflow across all my portals and draw it as a diagram.”
- “Import the lead-routing workflows from the sandbox, then deploy them to production. Show me the mapping before you deploy.”
- “Run the standard audit on the Acme portal and summarise the five biggest problems.”

## Tool Reference

The server has 24 core tools and 72 Projects tools. Your client lists them all, with their inputs, once you connect.

Most tools take IDs that other tools return. A typical order is `list_portals` → `browse_hubspot` → `start_import` → `get_task`, or `list_assets` → `get_mapping_structure` → `get_mapping_destinations` → `start_deploy`.

### Portals & Browse

| Tool                        | What it does                                                                                                                                                                                                        | Scope            |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| `list_portals`              | Lists the HubSpot portals connected to your organisation, with the portal IDs other tools need.                                                                                                                     | `portals:read`   |
| `browse_hubspot`            | Lists assets in a connected portal: workflows, forms, emails, lists, pipelines, pages, templates, blog posts, HubDB tables, properties, property groups or custom objects. Returns the HubSpot IDs used for import. | `hubspot:browse` |
| `preview_workflow_mermaid`  | Fetches a workflow live from HubSpot and returns it as a Mermaid flowchart, without importing it.                                                                                                                   | `hubspot:browse` |
| `scan_portal_profiles`      | Profiles a portal’s workflows, lists, forms, emails or pipelines, so the assistant can match them to a use case. Cached for 24 hours; pass `fresh` to re-read HubSpot.                                              | `hubspot:browse` |
| `scan_all_portals_profiles` | Profiles one asset type across every connected portal, for questions like “which of my portals has the best MQL workflow”. Cached for 24 hours per portal.                                                          | `hubspot:browse` |

### Import & Library

| Tool                      | What it does                                                                                                            | Scope            |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------- |
| `start_import`            | Imports selected HubSpot assets into your Jetstack library, and can create a module from them. Returns a task ID.       | `hubspot:import` |
| `list_assets`             | Lists assets in your library, filtered by type or source portal. Returns the library IDs used for mapping and deploy.   | `assets:read`    |
| `search_library_profiles` | Searches structured profiles of imported assets: properties used, dependencies, enrolment criteria and actions.         | `assets:read`    |
| `get_asset_detail`        | Returns the full stored data for an imported asset, including its HubSpot definition and dependencies.                  | `assets:read`    |
| `get_workflow_mermaid`    | Returns an imported workflow as a Mermaid flowchart, labelled with email names, list names, property values and delays. | `assets:read`    |
| `list_modules`            | Lists your modules: collections of assets that deploy together.                                                         | `modules:read`   |
| `get_module`              | Returns one module with its asset breakdown.                                                                            | `modules:read`   |

### Deploy & Mapping

| Tool                       | What it does                                                                                                                                                | Scope            |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| `get_mapping_structure`    | Shows what has to be mapped before a deploy from one portal to another: properties, owners, pipelines and more, marked required or optional.                | `hubspot:deploy` |
| `get_mapping_destinations` | Lists the matching options in the target portal for one mapping type, such as properties, owners, pipelines, lifecycle stages, teams or association labels. | `hubspot:deploy` |
| `start_deploy`             | Deploys library assets or modules to a target portal with the mapping you provide. Returns a task ID.                                                       | `hubspot:deploy` |

### Tasks

| Tool         | What it does                                                                                                                 | Scope        |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `list_tasks` | Lists import and deploy tasks. Filter by type, or by status: `pending`, `processing`, `completed`, `incomplete` or `failed`. | `tasks:read` |
| `get_task`   | Returns a task’s progress for each asset, so you can see what succeeded and what failed.                                     | `tasks:read` |

A task that ends as `incomplete` has finished, but some assets were skipped or have unresolved dependencies. Filtering by `completed` doesn’t include it.

### Audits

| Tool                    | What it does                                                                                                                                                                        | Scope         |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `list_audit_blocks`     | Lists the blocks you can put in an audit template. Filter by report type or category (`general`, `sales_hub`, `marketing_hub`, `service_hub`, `automation`, `reporting`).           | `audit:read`  |
| `list_audit_templates`  | Lists Jetstack’s built-in templates and your organisation’s own.                                                                                                                    | `audit:read`  |
| `get_audit_template`    | Returns a template’s blocks and tier requirements.                                                                                                                                  | `audit:read`  |
| `create_audit_template` | Creates a custom template from block IDs. Use report type `SIMPLE` for audits run through the API.                                                                                  | `audit:write` |
| `run_audit`             | Starts an audit on a portal using a template, in `quick` or `full` mode. Returns an audit run ID. Only `SIMPLE` templates run here; `ADVANCED` templates need the Chrome extension. | `audit:write` |
| `get_audit_status`      | Returns an audit run’s status: `created`, `processing`, `completed` or `failed`.                                                                                                    | `audit:read`  |
| `get_audit_data`        | Returns the full report for a completed run: blocks, data points, recommendations and health scores.                                                                                | `audit:read`  |

### Projects

Projects tools work on [Projects](https://jetstack.ai/docs/projects). They need Projects to be turned on for your organisation. Check with `get_projects_enabled`, or see [Getting Access](https://jetstack.ai/docs/projects/getting-access).

What a token can do on a project is the overlap of two things: the token’s scopes, and the project role of the person who created the token. A token can never do more than its creator. Call `get_project_access` to see which actions are available before you write.

Write tools that start long work take an `idempotencyKey`. Reuse the same key when you retry the same call, and use a new key for new work.

#### Projects & Access

| Tool                           | What it does                                                                                                       | Scope            |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ---------------- |
| `get_projects_enabled`         | Checks whether Projects is turned on for your organisation.                                                        | `projects:read`  |
| `list_projects`                | Lists projects, with search, status filter and paging.                                                             | `projects:read`  |
| `get_project`                  | Returns a project’s settings, portal and status.                                                                   | `projects:read`  |
| `get_project_overview`         | Returns everything the project’s Overview page shows, as data.                                                     | `projects:read`  |
| `get_project_access`           | Returns your role, capabilities and the actions available to this token on a project.                              | `projects:read`  |
| `get_projects_roles`           | Returns the table of project roles and what each one can do.                                                       | `projects:read`  |
| `get_projects_openapi_json`    | Returns the OpenAPI document for the Projects API.                                                                 | `projects:read`  |
| `create_project`               | Creates a project on a HubSpot portal.                                                                             | `projects:admin` |
| `rename_project`               | Renames a project.                                                                                                 | `projects:admin` |
| `delete_projects_by_projectId` | Archives a project. Deployed objects stay in HubSpot and the history is kept. Archived projects can’t be restored. | `projects:admin` |

#### Credits

| Tool                                          | What it does                                                                                                                    | Scope              |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| `get_project_credits`                         | Returns your organisation’s Projects credit balance.                                                                            | `projects:read`    |
| `get_projects_credits_history`                | Lists credit ledger entries, newest first.                                                                                      | `projects:read`    |
| `post_projects_credits_purchases`             | Starts a credit purchase and returns a checkout link. A person completes the payment in a browser. Needs an organisation admin. | `projects:billing` |
| `get_projects_credits_purchases_by_sessionId` | Returns the status of a credit purchase.                                                                                        | `projects:read`    |

#### Members

| Tool                                           | What it does                                   | Scope            |
| ---------------------------------------------- | ---------------------------------------------- | ---------------- |
| `get_projects_members_by_projectId`            | Lists a project’s members and their roles.     | `projects:read`  |
| `get_projects_members_candidates_by_projectId` | Lists organisation members who could be added. | `projects:admin` |
| `post_projects_members_by_projectId`           | Adds a member to a project.                    | `projects:admin` |
| `patch_projects_members_by_projectId_userId`   | Changes a member’s role.                       | `projects:admin` |
| `delete_projects_members_by_projectId_userId`  | Removes a member.                              | `projects:admin` |

#### Portal

| Tool                                                          | What it does                                                                                                   | Scope            |
| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ---------------- |
| `get_projects_portal_by_projectId`                            | Returns what Jetstack knows about the project’s portal.                                                        | `projects:read`  |
| `put_projects_portal_by_projectId`                            | Binds the project to its portal. Refused if the project already has one.                                       | `projects:admin` |
| `get_projects_portal_onboarding_by_projectId`                 | Returns the state of the first portal scan, and whether the project is ready to use.                           | `projects:read`  |
| `post_projects_portal_rescan_by_projectId`                    | Re-reads the portal. Returns a refresh ID to poll.                                                             | `projects:write` |
| `get_projects_portal_refreshes_current_by_projectId`          | Returns the portal refresh in progress, or the most recent one.                                                | `projects:read`  |
| `get_projects_portal_scan_gate_by_projectId`                  | Says whether a Chrome extension scan can run, and what’s missing if not.                                       | `projects:read`  |
| `post_projects_portal_scan_by_projectId`                      | Queues a Chrome extension scan. Someone must then run it from a signed-in HubSpot tab with the extension open. | `projects:write` |
| `get_projects_portal_objects_by_projectId`                    | Lists the objects Jetstack has seen in the portal.                                                             | `projects:read`  |
| `get_projects_portal_objects_by_projectId_domain_hubspotId`   | Returns one portal object, with a preview, facts and where they came from.                                     | `projects:read`  |
| `get_projects_portal_relationships_summary_by_projectId`      | Summarises how the portal’s objects connect to each other.                                                     | `projects:read`  |
| `get_projects_portal_relationships_neighborhood_by_projectId` | Returns the objects connected to one object.                                                                   | `projects:read`  |

#### Documents

| Tool                                                      | What it does                                                            | Scope               |
| --------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------- |
| `post_projects_documents_by_projectId`                    | Uploads a document (up to 20 MB, sent as base64) and starts reading it. | `projects:chat`     |
| `get_projects_documents_by_projectId`                     | Lists uploaded documents.                                               | `projects:read`     |
| `get_projects_documents_by_projectId_documentId`          | Returns one document, with what was extracted from it.                  | `projects:read`     |
| `get_projects_documents_download_by_projectId_documentId` | Returns a download link for the original file.                          | `projects:read`     |
| `post_projects_documents_analyze_by_projectId`            | Analyses documents into Project Knowledge. Spends credits.              | `projects:generate` |
| `get_projects_operations_by_projectId`                    | Lists long-running operations, such as document analysis and planning.  | `projects:read`     |
| `get_projects_operations_by_projectId_operationId`        | Returns one operation’s progress.                                       | `projects:read`     |

#### Knowledge

See [Project Knowledge](https://jetstack.ai/docs/projects/knowledge) for how the brief and decisions work.

| Tool                                                       | What it does                                                                                                            | Scope               |
| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `get_project_knowledge`                                    | Returns the published project brief: summary and metrics.                                                               | `projects:read`     |
| `get_projects_knowledge_brief_by_projectId`                | Returns every item in the brief.                                                                                        | `projects:read`     |
| `get_projects_knowledge_claims_by_projectId`               | Returns the claims behind the brief, with their evidence.                                                               | `projects:read`     |
| `get_projects_knowledge_versions_by_projectId`             | Lists published Knowledge versions, newest first.                                                                       | `projects:read`     |
| `get_projects_knowledge_versions_by_projectId_version`     | Returns one Knowledge version in full.                                                                                  | `projects:read`     |
| `list_project_decisions`                                   | Returns the decisions waiting for an answer, with evidence and the allowed answers.                                     | `projects:read`     |
| `get_projects_knowledge_decisions_by_projectId_decisionId` | Returns one decision.                                                                                                   | `projects:read`     |
| `resolve_project_decision`                                 | Answers one decision. Pass the version from `list_project_decisions`; out-of-date answers are refused.                  | `projects:write`    |
| `post_projects_knowledge_reviews_by_projectId`             | Submits several decisions at once.                                                                                      | `projects:write`    |
| `get_projects_knowledge_reviews_by_projectId`              | Lists past reviews.                                                                                                     | `projects:read`     |
| `get_projects_knowledge_reviews_by_projectId_reviewId`     | Returns one review.                                                                                                     | `projects:read`     |
| `post_projects_knowledge_suggestions_by_projectId`         | Asks Jetty to suggest answers to open decisions. Spends credits. Suggestions aren’t applied until someone submits them. | `projects:generate` |
| `get_projects_knowledge_identities_by_projectId`           | Returns the queue of records that may be the same thing and need a check.                                               | `projects:read`     |

#### Blueprint

| Tool                                                   | What it does                                                               | Scope               |
| ------------------------------------------------------ | -------------------------------------------------------------------------- | ------------------- |
| `get_project_blueprint`                                | Returns the project’s plan of record and whether a new one can be derived. | `projects:read`     |
| `derive_project_blueprint`                             | Derives a new Blueprint from published Knowledge. Spends credits.          | `projects:generate` |
| `get_projects_blueprint_versions_by_projectId`         | Lists Blueprint versions, newest first.                                    | `projects:read`     |
| `get_projects_blueprint_versions_by_projectId_version` | Returns one Blueprint version.                                             | `projects:read`     |

#### Assets

| Tool                                                              | What it does                                                                                                                                     | Scope               |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------- |
| `list_project_assets`                                             | Lists the assets on the project’s canvas. These IDs belong to the project, not your library.                                                     | `projects:read`     |
| `get_project_asset`                                               | Returns one asset in full.                                                                                                                       | `projects:read`     |
| `get_project_asset_spec`                                          | Returns an asset’s specification.                                                                                                                | `projects:read`     |
| `get_projects_assets_description_by_projectId_assetId`            | Describes what an asset does, in plain language.                                                                                                 | `projects:read`     |
| `get_projects_assets_issues_by_projectId_assetId`                 | Lists every validation issue on an asset.                                                                                                        | `projects:read`     |
| `get_projects_assets_impact_by_projectId_assetId`                 | Shows what removing or detaching an asset would affect.                                                                                          | `projects:read`     |
| `get_projects_assets_hubspot_link_by_projectId_assetId`           | Returns a link to the asset in HubSpot.                                                                                                          | `projects:read`     |
| `post_projects_assets_verify_by_projectId_assetId`                | Reads the asset back from HubSpot to confirm it’s live as built.                                                                                 | `projects:write`    |
| `post_projects_assets_repair_by_projectId_assetId`                | Repairs a failed asset. Spends credits.                                                                                                          | `projects:generate` |
| `post_projects_assets_restore_by_projectId_assetId`               | Re-applies the project’s version of an asset, overwriting changes made directly in HubSpot.                                                      | `projects:generate` |
| `get_projects_assets_repairs_by_projectId_assetId_idempotencyKey` | Returns the record of a repair.                                                                                                                  | `projects:read`     |
| `post_projects_assets_retire_by_projectId_assetId`                | Discards a draft, stops tracking an asset (detach), or deletes it from the portal (remove). Remove needs the asset’s exact name as confirmation. | `projects:deploy`   |

#### Runs & Deploy Log

| Tool                                                               | What it does                                                                                                                        | Scope               |
| ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `list_project_runs`                                                | Lists build, deploy, verify and scan runs, newest first. `queued`, `running`, `waiting_on_extension` and `paused` are not finished. | `projects:read`     |
| `get_project_run`                                                  | Returns a run’s progress, errors and per-asset results.                                                                             | `projects:read`     |
| `post_projects_runs_resume_by_projectId_runId`                     | Resumes a run that paused because credits ran out.                                                                                  | `projects:generate` |
| `get_projects_deploy_log_by_projectId`                             | Returns the project’s deploy receipts. See [Deploying & Fixing](https://jetstack.ai/docs/projects/deployment).                      | `projects:read`     |
| `get_projects_deploy_log_runs_by_projectId_runId`                  | Returns each attempt in one run.                                                                                                    | `projects:read`     |
| `get_projects_deploy_log_receipts_by_projectId_taskId__ae2b7f7cc0` | Returns the receipt for one Chrome extension request.                                                                               | `projects:read`     |

## Related

[Jetstack CLI ](https://jetstack.ai/docs/developers/cli)The same actions from your terminal, plus a Claude Code setup.

[API Reference ](https://jetstack.ai/api)Every REST endpoint the tools call, with requests and responses.

[Authentication ](https://jetstack.ai/docs/developers/authentication)Access tokens, scopes and Instance IDs.
