> ## Documentation Index
> Fetch the complete documentation index at: https://docs-v2.sortx.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP server

> Let an AI assistant such as Claude work with your SortX workspace through the Model Context Protocol.

The SortX MCP server gives an MCP client (any client that speaks streamable HTTP and can send a
custom header, such as Claude Code) the same operations as the
[API](/api-reference/introduction), as tools.

## Tools

Every API endpoint is one tool, named `<group>.<endpoint>`. Tools are generated from the same
contract as the API, so their inputs and descriptions always match the API reference.

A client only sees the tools its key may use:

* **Scopes**: a tool is listed only if the key has `<group>:read` (for reads) or
  `<group>:write` (for everything else). A read-only key never sees a tool that changes data.
* **Products**: tools for a product your workspace does not have are hidden.

Calls go through the same checks as the API: the key, its workspace, its scopes, and the
workspace's own data boundaries. The assistant can only do what the key could do over HTTP.

## Connect a client

<Steps>
  <Step title="Create a key for the assistant">
    In **Settings → API keys**, create a key just for this client with only the scopes it
    needs ([API keys](/developers/api-keys)). Start read-only.
  </Step>

  <Step title="Open Settings → MCP">
    The page shows your MCP server's address and ready-to-paste client configuration, a
    **Test connection** button, and for each key the exact tools that key is offered.
  </Step>

  <Step title="Point your client at the address">
    Use streamable HTTP and send the key in the `x-api-key` header.
  </Step>
</Steps>

<Note>
  If **Settings → MCP** shows no address, the hosted MCP server is not published for your
  workspace yet. SortX never shows a placeholder address.
</Note>

## Good practice

* One key per assistant, so you can see and revoke each one on its own.
* Keep write scopes to what the assistant should change. AI suggests; your staff decide.
* Revoke the key when you stop using the client: its tools disappear at once.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.