Build on Qualy with LLMs

You can use large language models (LLMs) to assist in the building of Qualy integrations. We provide a set of tools and best practices if you use LLMs during development.

Qualy Model Context Protocol (MCP) Server

You can use the Qualy Model Context Protocol (MCP) server if you use code editors that use AI, such as Cursor or Windsurf, or general purpose tools such as Claude Desktop. The MCP server provides AI agents a set of tools you can use to call the Qualy API and search our knowledge base (documentation, support articles, and so on).

How to use the MCP Server

1. Using the REST API

You can interact with the MCP Server programmatically using its REST API.

Example: Creating a contact via REST API

try {
  const response = await fetch('https://api.qualyhq.com/v1/mcp/chat', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'ApiKey your-api-key-here',
      'X-TENANT-ID': 'your-tenant-id-here',
    },
    body: JSON.stringify({
      "prompt": "Create a new contact named John Jones, john@gmail.com..."
    }),
  });

  if (response.ok) {
    const data = await response.json();

    console.log(data);
  } else {
    throw new Error(`Request failed with status: ${response.status}`);
  }
} catch (error) {
  console.error(error);
}

Response:

{
  "data": {
    "text": "OK. Contact created..."
  }
}

See the Qualy's MCP Server API Reference for more details.

2. Using email workflows

For organizations that prefer not to build a direct API integration, the MCP Server can be used via email. This is is useful for automating workflows from systems that can send emails but not make HTTP requests.

Note that only emails from active users will be processed. And ApiKey users are not supported.

Example: Creating a contact via email

Send an email to inbox@assistant.qualyhq.com with the following format:

Subject: New Payment Request
Body:

Qualy, please create a new contact named John Jones, john@gmail.com...

You will receive a confirmation email with the contact details and link. Use the email inbox@staging-assistant.qualyhq.com to use it in sandbox.

Features overview

Technical capabilities overview