Skip to main content

Overview

Knot provides an to allow you to interact with the API via natural language prompting. The MCP server provides a tool for each endpoint on the API, as well as a tool to search these docs themselves, all via natural language prompting. This functionality is particularly useful when integrating Knot for the first time via Knot’s development environment. The MCP server (once installed into your coding environment) can allow you to work with the API more quickly. The MCP server for Knot’s API exists at https://docs.knotapi.com/mcp.

Example Use Cases

Use CaseExample Prompt
Search the docs"How do I integrate the knot iOS SDK"
Create a session"Create a cardswitcher session with external user ID: 123abc and card ID: abc123"
Retrieve available merchants"What merchants are available for the cardswitcher product on iOS?"
Get a public key to encrypt card data"What is the public key I should use to encrypt card data?"

Setup

1

Configure the MCP

Option 1

Select your preferred AI tool (e.g. Cursor) from the options menu at the top right of this page to automatically install the Knot MCP server.Options Menu

Option 2

Using the Knot MCP server URL (https://docs.knotapi.com/mcp ), follow the instructions from your preferred AI on configuring a new MCP server.
2

Begin prompting

Begin asking questions or prompting the agent to perform a task for you, such as create a session for the SDK.
When you call an MCP tool that requires authentication for the first time (all except searchDocs, you’ll be prompted for your API key (likely for the development environment if you are integrating Knot). Provide your API key. If you have not already created your API key, you can learn about how to do so here. Note that searching these docs via the MCP does not require authentication.