Getting Started with Cursor
Connect your Collate instance to Cursor IDE for AI-powered metadata exploration.Prerequisites
Before you begin, ensure you have:- Collate v1.8.0+ running
- MCP Application installed in Collate
- Navigate to
<YOUR-Collate-SERVER>/marketplace/apps/McpApplication - Install McpApplication if not already installed
- Navigate to
- Cursor IDE installed with MCP support
Connect with OAuth 2.0 (Recommended)
OAuth lets you authenticate using your existing Collate login, with no tokens to manage.Step 1: Open MCP Settings
In Cursor, navigate to Settings and click Tools & MCP in the left sidebar.
Step 2: Add a New MCP Server
Click New MCP Server. This will open themcp.json configuration file.
Step 3: Configure the Server
Add the following configuration tomcp.json:
<YOUR-Collate-SERVER> with your Collate instance URL (e.g., your-collate-instance.com).
Step 4: Authenticate
Save the file and Cursor will attempt to connect. A browser window will open prompting you to sign in with your Collate credentials. Follow the on-screen instructions based on your configured authentication method:- SSO (Google, Azure, Okta, etc.): You will be redirected to your SSO provider’s login page
- Basic Auth: Enter your Collate username and password
Connect with Personal Access Token (PAT)
If you prefer token-based authentication or OAuth is not available in your environment, you can use a Personal Access Token.Step 1: Generate a PAT
Follow the Personal Access Token guide to generate your token.Step 2: Configure MCP Server
Cursor locates the MCP configuration file at: macOS/Linux:.cursor directory if it doesn’t exist, then create or update the configuration file:
<YOUR-Collate-SERVER> with your server URL and <YOUR-Collate-PAT> with your Personal Access Token.
Step 3: Restart Cursor
Save the configuration file and restart Cursor completely to load the MCP server:- macOS:
Cmd+Qor Cursor > Quit Cursor - Windows/Linux: Close all Cursor windows and reopen
Project-Specific Configuration: You can also create .cursor/mcp.json in your project root directory. Project-specific configuration takes precedence over global configuration.
Try It Out
Once connected, test your setup by asking questions in Cursor’s chat:“Imagine you’re a data analyst tasked with building a customer retention dashboard. You need tables that track customer transactions, engagement metrics, and churn indicators. Find relevant customer and transaction tables in the metadata catalog.”You should see Cursor using the Collate MCP tools to search and retrieve information from your metadata catalog.
Troubleshooting
If you encounter connection issues:- Verify Collate is running:
curl <YOUR-Collate-SERVER>/api/health - Check MCP endpoint:
curl <YOUR-Collate-SERVER>/mcp(should return 401) - Verify MCP Application is installed: Visit
<YOUR-Collate-SERVER>/marketplace/apps/McpApplication - Re-authenticate: Remove and re-add the server in Cursor to trigger a fresh OAuth login
- Check configuration file syntax: Ensure JSON is valid and file path is correct
- Token expired (PAT method): Generate a new PAT and update your configuration
- Restart Cursor after making configuration changes