Nyne Nyne API Login
Quick Start

Nyne MCP Quick Start

Get up and running with Nyne MCP in three minutes.

What you'll need

  • A Nyne account with an active subscription
  • API credentials (API Key + Secret)
  • An MCP-capable client - Claude (Code or Desktop), ChatGPT, Cursor, VS Code, Windsurf, Zed, or a CLI agent

Agent discovery links

If an agent is integrating without prior context, point it at the machine-readable docs before the HTML pages - that reduces bad endpoint selection and noisy scraping.

llms.txt:               https://api.nyne.ai/llms.txt
Agent manifest:         https://api.nyne.ai/.well-known/nyne-api.json
Example endpoint (md):  https://api.nyne.ai/documentation/person/enrichment.md

The hosted MCP is a curated subset focused on person search, enrichment, and profile Q&A. For broader coverage, use the manifest and endpoint markdown docs first.

Connect your client

The Nyne MCP server is remote (hosted) - there is nothing to install. Point any MCP-capable client at https://api.nyne.ai/mcp and authenticate with one of:

  • OAuth 2.0 (recommended) - interactive login, no keys to store. Best for hosted assistants like ChatGPT and Claude Desktop.
  • API Key headers - send X-API-Key and X-API-Secret. Best for editors and CLIs that read a config file.
  • Bearer token - paste your API key where a client only offers a single token field.
Replace the placeholders
Swap YOUR_API_KEY / YOUR_API_SECRET for the credentials from your Nyne dashboard. Treat them like passwords - prefer your client's secret-input or environment-variable support over committing them to a shared file.

Hosted assistants

ChatGPT

  1. Open ChatGPT → Settings → Connectors (custom connectors require Developer mode; Plus, Pro, Business, or Enterprise).
  2. Click Add custom connector and enter https://api.nyne.ai/mcp.
  3. Choose OAuth and complete Nyne login. The OAuth endpoints are:
    Authorization URL: https://api.nyne.ai/mcp/oauth/authorize
    Token URL: https://api.nyne.ai/mcp/oauth/token
  4. ChatGPT cannot send custom X-API-Key headers - if OAuth is unavailable, paste your Nyne API key in the Bearer token field instead.
  5. Save and test.

Claude Desktop

  1. Open Settings → Connectors → Add custom connector.
  2. Name it nyne, set the URL to https://api.nyne.ai/mcp, and complete the OAuth login.
  3. Prefer API keys? The Connectors UI is OAuth-only, so bridge with mcp-remote in claude_desktop_config.json (Settings → Developer → Edit Config):
    {
      "mcpServers": {
        "nyne": {
          "command": "npx",
          "args": [
            "mcp-remote",
            "https://api.nyne.ai/mcp",
            "--header",
            "X-API-Key:${API_KEY}",
            "--header",
            "X-API-Secret:${API_SECRET}"
          ],
          "env": {
            "API_KEY": "YOUR_API_KEY",
            "API_SECRET": "YOUR_API_SECRET"
          }
        }
      }
    }
  4. Restart Claude Desktop.

Command-line tools

Claude Code

Run:

claude mcp add --transport http nyne https://api.nyne.ai/mcp \
  --header "X-API-Key: YOUR_API_KEY" \
  --header "X-API-Secret: YOUR_API_SECRET"

Add -s user before the name to register it globally instead of per-project.

Gemini CLI

Run:

gemini mcp add --transport http \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  nyne https://api.nyne.ai/mcp

In ~/.gemini/settings.json the URL key is httpUrl (not url) for HTTP servers.

Codex CLI

Add to~/.codex/config.toml:

[mcp_servers.nyne]
url = "https://api.nyne.ai/mcp"
http_headers = { "X-API-Key" = "YOUR_API_KEY", "X-API-Secret" = "YOUR_API_SECRET" }

Codex uses http_headers (not headers). On older builds, add experimental_use_rmcp_client = true at the top of the file.

GitHub Copilot CLI

Add to~/.copilot/mcp-config.json:

{
  "mcpServers": {
    "nyne": {
      "type": "http",
      "url": "https://api.nyne.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY",
        "X-API-Secret": "YOUR_API_SECRET"
      },
      "tools": [
        "*"
      ]
    }
  }
}

OpenCode

Add toopencode.json:

{
  "mcp": {
    "nyne": {
      "type": "remote",
      "url": "https://api.nyne.ai/mcp",
      "enabled": true,
      "headers": {
        "X-API-Key": "YOUR_API_KEY",
        "X-API-Secret": "YOUR_API_SECRET"
      }
    }
  }
}

OpenCode nests servers under mcp (not mcpServers) and needs type: "remote".

Editors & IDEs

Cursor

Add to~/.cursor/mcp.json:

{
  "mcpServers": {
    "nyne": {
      "url": "https://api.nyne.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY",
        "X-API-Secret": "YOUR_API_SECRET"
      }
    }
  }
}

VS Code (GitHub Copilot)

Add to.vscode/mcp.json:

{
  "servers": {
    "nyne": {
      "type": "http",
      "url": "https://api.nyne.ai/mcp",
      "headers": {
        "X-API-Key": "${input:nyne-key}",
        "X-API-Secret": "${input:nyne-secret}"
      }
    }
  },
  "inputs": [
    {
      "type": "promptString",
      "id": "nyne-key",
      "description": "Nyne API Key",
      "password": true
    },
    {
      "type": "promptString",
      "id": "nyne-secret",
      "description": "Nyne API Secret",
      "password": true
    }
  ]
}

The top-level key is servers (not mcpServers). The inputs block prompts for each secret on first run; hardcode the values instead if you prefer.

Windsurf

Add to~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "nyne": {
      "serverUrl": "https://api.nyne.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY",
        "X-API-Secret": "YOUR_API_SECRET"
      }
    }
  }
}

Windsurf uses serverUrl (not url) for remote servers.

Zed

Add to your Zedsettings.json:

{
  "context_servers": {
    "nyne": {
      "url": "https://api.nyne.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY",
        "X-API-Secret": "YOUR_API_SECRET"
      }
    }
  }
}

Needs a recent Zed with native HTTP MCP support; older builds require the mcp-remote stdio bridge.

JetBrains (Junie)

Add to.junie/mcp/mcp.json:

{
  "mcpServers": {
    "nyne": {
      "url": "https://api.nyne.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY",
        "X-API-Secret": "YOUR_API_SECRET"
      }
    }
  }
}

Junie supports header auth. The plain AI Assistant remote-server form is URL-only - use Junie's config or an mcp-remote bridge there.

Test it out

Try these example queries in your AI assistant:

Search for people

"Find software engineers at Google in Seattle"
"Show me CTOs in the fintech industry"
"Search for product managers with AI experience"

Get profile details

"Get the profile for [email protected]"
"Find contact info for linkedin.com/in/janedoe"
"Enrich this phone: (415) 555-1234"

Ask AI questions

"What is this person's current role?"
"Does this person have sales experience?"
"What companies has this person worked for?"
That's it
Your AI assistant can now search and analyze Nyne's people data directly.

Quick reference

What Value
Discovery URL https://api.nyne.ai/.well-known/mcp
MCP endpoint https://api.nyne.ai/mcp
Auth method OAuth2 (recommended) via /mcp/oauth • Bearer token (API Key) • X-API-Key + X-API-Secret
Protocol version 2024-11-01

Credits & pricing

MCP uses the same credit costs as the REST API.

Tool Credit action
search_people_semantic person_search
get_person_profile person_enrichment
ask_profile person_enrichment
Dynamic pricing
MCP uses your existing Nyne credits and respects your API rate limits. Costs are loaded from your account and update automatically if they change.

Async processing

  1. Tool invocation returns HTTP 202 with a request_id.
  2. Poll GET /mcp/status?request_id=xxx every 2-3 seconds.
  3. When status is completed, results are included in the response.
Polling is automatic
Your AI assistant handles polling for you - just ask questions naturally and it waits for results.

Next steps