Cursor

Overview

These docs specify how a user signs up for Tarxan, and deploys a server via Cursor.

1. Add MCP Server to Cursor

Add the tarxan-mcp server to mcp.json. [File -> Preferences -> Cursor Settings -> MCP -> + Add new global MCP server]

{
  "mcpServers": {
    "tarxan-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@pineappleworkshop-tarxan/[email protected]"
      ]
    }
  }
}

2. Ensure Cursor sees Tarxan MCP

Update LLM context with the available actions provided by Tarxan.

3. Initiate Tarxan Signup

Start the signup flow to fully configure tarxan locally, and the user on the platform.

4. Submit Email

The email for the user. (check spam if no verification email is in inbox)

5. Verify Email

Emails are verified via a one-time password. Thereafter the ~/.tarxan/config.toml that is created acts as the global config for Tarxan on your local machine. Lastly, a default API key is created and stored within the config.

6. List Templates

Templates are the supported frameworks in which a user can deploy as a server. Some templates require subdomains, other persistent storage.

7. Deploy a Server

Servers are deployable by template named, and are provisioning on the Tarxan infrastructure.

8. Provide Required Credentials

A template may require values and credentials, the LLM will prompt you for these. These credentials are stored securely in a key management system without traces in the platform's database. Currently, credentials are not retrievable so write your credential down when creating a server.

9. Check Tarxan for Server

Navigate to tarxan.io, signin using same email and verify the one-time password. This is the same account you initialized within cursor.

10. Delete Server