---
title: "Workspace tools"
description: "Tools every connection gets: workspace overview, credit balance, app links, file uploads and Help Centre search."
url: "https://sellify.ai/docs/developers/mcp-tools/workspace"
---

# Workspace tools

> Tools every connection gets: workspace overview, credit balance, app links, file uploads and Help Centre search.

Tools every connection gets: workspace overview, credit balance, app links, file uploads and Help Centre search. This page lists 5 tools, 4 of them read-only.

- [`get_workspace_context`](#get_workspace_context): Get workspace context
- [`get_credit_balance`](#get_credit_balance): Get credit balance and usage
- [`get_app_link`](#get_app_link): Get a link into the Sellify app
- [`search_docs`](#search_docs): Search the Sellify Help Centre
- [`create_file_upload`](#create_file_upload): Get a link to upload a file to Sellify

## `get_workspace_context`

**Get workspace context**

Start here once per fresh conversation. Returns the current workspace’s member-visible identity, onboarding website, plan summary, credit balance, permission-aware products and recommended brands, plus validated next actions and starter prompts. It makes no provider calls and performs no paid work.

| Property       | Value                              |
| -------------- | ---------------------------------- |
| Access         | Read-only                          |
| Scope          | None, every connection can call it |
| Credits        | Free                               |
| Safe to repeat | Yes                                |

### Input

This tool takes no input.

### Output

| Field               | Type            | Description   |
| ------------------- | --------------- | ------------- |
| `version`           | 1               |               |
| `workspace`         | object          |               |
| `partial`           | boolean         |               |
| `plan`              | object          |               |
| `credits`           | object          |               |
| `onboarding`        | object          |               |
| `products`          | object          |               |
| `recommendedBrands` | object          |               |
| `capabilities`      | object          |               |
| `suggestedActions`  | object          |               |
| `suggestedPrompts`  | array of string | Items 2 to 3. |
| `nextStep`          | object          |               |

### Example

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_workspace_context",
    "arguments": {}
  }
}
```

## `get_credit_balance`

**Get credit balance and usage**

Free. Returns the workspace credit balance plus this connection's daily credit limit, usage, remaining allowance, and UTC reset time.

| Property       | Value                              |
| -------------- | ---------------------------------- |
| Access         | Read-only                          |
| Scope          | None, every connection can call it |
| Credits        | Free                               |
| Safe to repeat | Yes                                |

### Input

This tool takes no input.

### Output

| Field                   | Type               | Description |
| ----------------------- | ------------------ | ----------- |
| `workspace_credits`     | number             |             |
| `daily_credit_limit`    | number             |             |
| `daily_credits_used`    | number             |             |
| `daily_credits_left`    | number             |             |
| `daily_limit_resets_at` | string (date-time) |             |

### Example

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_credit_balance",
    "arguments": {}
  }
}
```

## `get_app_link`

**Get a link into the Sellify app**

Returns an app.sellify.ai link to a page or record in the current workspace, where the user can view, compare, or finish something in the dashboard.

| Property       | Value                              |
| -------------- | ---------------------------------- |
| Access         | Read-only                          |
| Scope          | None, every connection can call it |
| Credits        | Free                               |
| Safe to repeat | Yes                                |

### Input

| Field          | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| -------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `page`         | enum   | Yes      | Which page to open. products: the product list. product: one product (needs productId). product\_ads: every ad made for a product (needs productId). angles: every sales angle. build\_ad: the ad builder, optionally preset with productId and angleId. clone\_ads: the winning ads library to clone from, optionally preset with productId. ad\_library: every generated ad. deleted\_ads: deleted ads, where the user can restore or permanently delete them. generated\_ads: the ads from one generation (needs submissionId). board: one generated-ad library board (needs boardId). ad\_spy: Ad Spy discovery, optionally searching query. ad\_spy\_saved: saved Ad Spy ads. ad\_spy\_board: one Ad Spy board of saved ads (needs boardId). ad\_spy\_ad: one Ad Spy ad (needs adArchiveId). ad\_spy\_brand: one advertiser (needs pageId, optionally brandName). sellify\_agent: the Sellify Agent chat. workflow: one scheduled workflow (needs workflowId). billing: plan, credits and invoices. members: workspace members. One of: `products`, `product`, `product_ads`, `angles`, `build_ad`, `clone_ads`, `ad_library`, `deleted_ads`, `generated_ads`, `board`, `ad_spy`, `ad_spy_saved`, `ad_spy_board`, `ad_spy_ad`, `ad_spy_brand`, `sellify_agent`, `workflow`, `billing`, `members`. |
| `productId`    | string | No       | Length 1 to 200.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `angleId`      | string | No       | Length 1 to 200.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `submissionId` | string | No       | Length 1 to 200.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `boardId`      | string | No       | Length 1 to 200.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `adArchiveId`  | string | No       | Length 1 to 200.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `pageId`       | string | No       | Length 1 to 200.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `brandName`    | string | No       | Length 1 to 200.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `workflowId`   | string | No       | Length 1 to 200.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `query`        | string | No       | Length 1 to 200.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

### Output

| Field     | Type   | Description                                                                                                                                                                                                                                                       |
| --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page`    | enum   | One of: `products`, `product`, `product_ads`, `angles`, `build_ad`, `clone_ads`, `ad_library`, `deleted_ads`, `generated_ads`, `board`, `ad_spy`, `ad_spy_saved`, `ad_spy_board`, `ad_spy_ad`, `ad_spy_brand`, `sellify_agent`, `workflow`, `billing`, `members`. |
| `app_url` | string |                                                                                                                                                                                                                                                                   |

### Example

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_app_link",
    "arguments": {
      "page": "products"
    }
  }
}
```

## `search_docs`

**Search the Sellify Help Centre**

Searches the Sellify Help Centre for how the product works: credits, plans, creating ads, products and angles, Ad Spy, boards, Meta and Google ads, and workspace settings. Returns each page title, a snippet, its URL and a markdown URL. Set includeContent to get the full page as markdown.

| Property       | Value                              |
| -------------- | ---------------------------------- |
| Access         | Read-only                          |
| Scope          | None, every connection can call it |
| Credits        | Free                               |
| Safe to repeat | Yes                                |

### Input

| Field            | Type    | Required | Description                                                                   |
| ---------------- | ------- | -------- | ----------------------------------------------------------------------------- |
| `query`          | string  | Yes      | What to look up, in plain words, e.g. "how do credits work". Length 2 to 200. |
| `limit`          | integer | No       | How many pages to return. Defaults to 5. Between 1 and 10.                    |
| `includeContent` | boolean | No       | Return the full markdown of each matching page, not just a snippet.           |

### Output

| Field     | Type            | Description |
| --------- | --------------- | ----------- |
| `query`   | string          |             |
| `results` | array of object |             |

### Example

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_docs",
    "arguments": {
      "query": "example"
    }
  }
}
```

## `create_file_upload`

**Get a link to upload a file to Sellify**

Starts a file upload when the file cannot be passed to a tool directly, for example a photo or document the user attached in Claude, or a file saved on their computer or phone. Call it as soon as the user mentions such a file, without first asking them to attach it in chat, and share upload\_page\_url with them. Returns an upload page link for the user, and an upload URL you can PUT the file to yourself when you pass mime\_type and size\_bytes. In ChatGPT, pass the attached file straight to the tool that needs it instead. For a file already on a public website, pass its url to the tool that needs it instead.

| Property | Value                                                          |
| -------- | -------------------------------------------------------------- |
| Access   | Writes data                                                    |
| Scope    | Products: write (`products:write`) or Ads: write (`ads:write`) |
| Credits  | Free                                                           |

### Input

| Field        | Type    | Required | Description                                                                                                                                                                                                                                                                                                                |
| ------------ | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `purpose`    | enum    | Yes      | What the file is for. hero\_image: a product photo to add to a saved product. research\_document: a PDF, Word, text or Markdown document about a saved product. ad\_reference\_image: a picture to follow when building an image ad from a written brief. One of: `hero_image`, `research_document`, `ad_reference_image`. |
| `mime_type`  | string  | No       | The file type, such as image/png or application/pdf. Pass it together with size\_bytes when you can upload the file yourself. Length 1 to 200.                                                                                                                                                                             |
| `size_bytes` | integer | No       | The exact file size in bytes. Pass it together with mime\_type.                                                                                                                                                                                                                                                            |

### Output

| Field             | Type            | Description |
| ----------------- | --------------- | ----------- |
| `upload_id`       | string          |             |
| `expires_at`      | string          |             |
| `upload_page_url` | string          |             |
| `put_url`         | string          |             |
| `put_headers`     | object          |             |
| `max_bytes`       | number          |             |
| `allowed_types`   | array of string |             |
| `next_step`       | string          |             |

### Example

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_file_upload",
    "arguments": {
      "purpose": "hero_image"
    }
  }
}
```

## Related

[Tool reference overview](https://sellify.ai/docs/developers/mcp-tools) · [Authentication](https://sellify.ai/docs/developers/authentication) · [Credits and limits](https://sellify.ai/docs/developers/credits-and-limits)
