quick start

tiroir uses the model context protocol (mcp) to connect with your ai assistants. here's what you need:

• a tiroir account with an api key
• an mcp-compatible ai assistant (chatgpt, claude, cursor, or continue)
• 2 minutes of your time

ai integrations

chatgpt desktop app

• open chatgpt desktop settings
• navigate to the integrations tab
• enable model context protocol (mcp)
• click add server
• paste this configuration:

{
  "mcpServers": {
    "tiroir": {
      "command": "npx",
      "args": [
        "-y",
        "@tiroir/mcp-client",
        "--token",
        "YOUR_API_KEY_HERE"
      ]
    }
  }
}

• replace YOUR_API_KEY_HERE with your actual api key from the dashboard
• restart chatgpt desktop
• start a new chat and ask: "can you see tiroir?"

---

claude desktop app

• locate your claude config file:

- macos: ~/Library/Application Support/Claude/claude_desktop_config.json - windows: %APPDATA%\Claude\claude_desktop_config.json - linux: ~/.config/Claude/claude_desktop_config.json

• open the file in a text editor (create it if it doesn't exist)

• add this configuration:

{
  "mcpServers": {
    "tiroir": {
      "command": "npx",
      "args": [
        "-y",
        "@tiroir/mcp-client",
        "--token",
        "YOUR_API_KEY_HERE"
      ]
    }
  }
}

• replace YOUR_API_KEY_HERE with your api key
• restart claude desktop
• look for the 🔌 icon in the input box - it shows tiroir is connected!

---

cursor editor

• open cursor settings (cmd+, on mac, ctrl+, on windows/linux)
• search for mcp in settings
• click edit in settings.json
• add the tiroir server configuration:

{
  "mcp.servers": {
    "tiroir": {
      "command": "npx",
      "args": [
        "-y",
        "@tiroir/mcp-client",
        "--token",
        "YOUR_API_KEY_HERE"
      ]
    }
  }
}

• reload cursor
• tiroir will now be available in composer and chat!

---

continue.dev

• open continue settings (click the gear icon in continue sidebar)
• find the mcp servers section
• click add server
• add this configuration:

{
  "name": "tiroir",
  "command": "npx",
  "args": [
    "-y",
    "@tiroir/mcp-client",
    "--token",
    "YOUR_API_KEY_HERE"
  ]
}

• save and reload
• ask continue: "search tiroir for project documentation"

connect your sources

once tiroir is connected to your ai, you can add data sources:

google drive

• go to your dashboard
• click add source → google drive
• authenticate with google
• select folders to index
• tiroir will automatically index your files

github

• go to your dashboard
• click add source → github
• authenticate with github
• select repositories to index
• tiroir will index your code and documentation

local files

coming soon! ability to index local file directories.

notion

coming soon! connect your notion workspace.

deployment options

tiroir can be used in multiple ways:

cloud (recommended)

use our hosted service at tiroir.me:

• no setup required
• automatic updates
• 99.9% uptime
• free tier available

self-hosted (vps)

deploy tiroir on your own server:

• clone the repository
• set environment variables
• run with docker or pm2
• see our vps deployment guide for details

local development

run tiroir locally for development:

git clone https://github.com/tiroir/tiroir-platform
cd tiroir-platform
npm install
npm run dev

see the quickstart guide for more.

troubleshooting

"tiroir not found" error

• make sure you've restarted your ai app after adding the config
• verify your api key is correct (copy from dashboard)
• check that npx is available in your terminal

connection issues

• ensure you have an active internet connection
• check if your firewall is blocking the connection
• verify your api key hasn't expired

slow responses

• first query might be slow as indexes load
• subsequent queries should be much faster
• contact support if issues persist

need help?

• join our discord
• check github issues
• email: support@tiroir.me