Tulip MCP Server
A Model Context Protocol (MCP) server that provides comprehensive access to the Tulip API, enabling LLMs to interact with the Tulip manufacturing platform functionality including tables, records, machines, stations, interfaces, users, and more.
⨠Prerequisites
Before you begin, ensure you have Node.js installed on your system. This is required to run the server.
š Getting Started
This guide will walk you through running the server and connecting it to an MCP client like Cursor or Claude Desktop.
1. Configure Your Credentials
Create a file named .env in a folder of your choice. Copy and paste the following, replacing the placeholders with your actual Tulip credentials.
Your
TULIP_BASE_URLis the URL you use to access Tulip (e.g.,https://my-company.tulip.co).Your
TULIP_WORKSPACE_IDis in your Tulip URL after/w/(for most users, this isDEFAULT).
ā ļø Important: The TULIP_WORKSPACE_ID is only required if you are using an Account API key (obtained from Account Settings). If you are using a Workspace API key (obtained from Workspace Settings), you can leave this field empty.
2. Run the Server
Open your terminal or command prompt, navigate to the folder containing your .env file, and run:
The server will start and is now ready to be connected to an MCP client.
š Connecting to an MCP Client
When using a client, the server is run in a different environment where it may not find your .env file automatically. To solve this, you must provide the full path to your .env file using the --env flag.
Navigate to the folder where you created your
.envfile.On Windows: Right-click the
.envfile while holding down theShiftkey, then select "Copy as path".On macOS: Right-click the
.envfile, hold down theOptionkey, then select "Copy .env as Pathname".You will use this copied path in the client configuration below.
From the Claude Desktop menu bar, select Settings... > Developer > Edit Config.
This will open the
claude_desktop_config.jsonfile.Add the server configuration inside the
mcpServersobject. You must replace{ "mcpServers": { "tulip-mcp": { "command": "npx", "args": [ "@tulip/mcp-server", "--env", "C:\\path\\to\\your\\.env" ] } } }Save the file and restart Claude Desktop.
For more details, see the official Claude Desktop MCP Quickstart.
For the easiest setup, click the button below. This will pre-fill the command.
After clicking the button, you must replace the placeholder text (REPLACE_WITH_YOUR_ENV_FILE_PATH_HERE) with the full path to your .env file that you copied earlier.
š ļø Developer Guide
This section contains more advanced configuration features.
Tool Selection Configuration
By default, the server enables only read-only tools and table tools for safety. You can customize which tools are available using the ENABLED_TOOLS environment variable in your .env file.
The ENABLED_TOOLS variable accepts a comma-separated list that can include:
Individual tool names: Specific tools like
listStationsCategories: Security-based groupings (
read-only,write,admin)Types: Resource-based groupings (
table,machine,user,app,interface,station,station-group,utility)
Examples
Multiple Workspace Configuration (Enterprise)
If your organization uses multiple Tulip workspaces or instances, you can set up multiple MCP servers to access all of them simultaneously. This lets you work with data from all your workspaces in a single conversation.
Understanding Your API Credentials
Before you begin, check what type of API credentials you have:
Workspace API Credentials: Created in Workspace Settings ā API Tokens
ā Already know which workspace they belong to
ā Do NOT include
TULIP_WORKSPACE_IDin your.envfileā Most common type for individual workspaces
Account API Credentials: Created in Account Settings ā API Tokens
ā ļø Can access multiple workspaces
ā ļø Must include
TULIP_WORKSPACE_IDin your.envfile
Not sure which type you have? Check where you created your API token. If you created it in Workspace Settings, you have Workspace API credentials.
Step-by-Step Setup
Step 1: Create separate
Follow the same process from Section 1: Configure Your Credentials, but create separate files:
Step 2: Configure each
For each workspace, create a .env file with the appropriate credentials:
If using Workspace API Credentials:
If using Account API Credentials:
Step 3: Connect multiple servers to your MCP client
Add each workspace as a separate server with a unique name using the guides from Section: Connecting to an MCP Client:
For Claude Desktop:
For Cursor: Use the install button multiple times, once for each .env file.
Tips for Success
Use clear server names like
tulip-production,tulip-qa,tulip-developmentTest each workspace separately first to ensure credentials work
Only enable the tools you need. Enabling too many tools (40+) can confuse the AI.
API Documentation
For detailed tool documentation including complete parameter lists, examples, and required permissions, generate the .
How to Get Tulip API Credentials
Log in to your Tulip instance.
Navigate to Settings > API Tokens.
Create a new API token. Give it a name (e.g., "MCP Server").
Make sure to grant it the necessary permissions (scopes). A good starting set for read-only access is:
stations:read,users:read,tables:read,machines:read,apps:read,urls:signCopy the API Key and Secret and paste them into your
.envfile.
ā ļø Important: The TULIP_WORKSPACE_ID is only required if you are using an Account API key (obtained from Account Settings). If you are using a Workspace API key (obtained from Workspace Settings), you can leave this field empty.