Sinyx MCP

MCP server for Sinyx web content extraction. It exposes the hosted Sinyx API as tools for AI clients such as Codex, Claude Code, Cursor, Windsurf, and other MCP-compatible apps.

Tools

| Tool | Purpose | |---|---| | sinyx_status | Checks API health, version, request ID, and extraction metadata | | sinyx_extract | Extracts one URL. Defaults to context; also supports full, markdown, text, html, and chunks | | sinyx_batch_extract | Extracts 1-5 URLs in one request. Defaults to context |

The extraction tools default to format: "context" because MCP clients are usually AI-agent workflows. Use another format only when you specifically need raw Markdown, text, cleaned HTML, full metadata, or chunks alone.

Quick Start

Use the package directly from npm-compatible clients with npx:

{
  "mcpServers": {
    "sinyx": {
      "command": "npx",
      "args": ["-y", "sinyx-mcp"],
      "env": {
        "SINYX_API_BASE_URL": "https://sinyx.p.rapidapi.com",
        "SINYX_API_KEY": "your-rapidapi-key",
        "SINYX_API_KEY_HEADER": "x-rapidapi-key",
        "SINYX_RAPIDAPI_HOST": "sinyx.p.rapidapi.com"
      }
    }
  }
}

If you are using Codex, you can add it with:

codex mcp add sinyx \
  --env SINYX_API_BASE_URL=https://sinyx.p.rapidapi.com \
  --env SINYX_API_KEY=your-rapidapi-key \
  --env SINYX_API_KEY_HEADER=x-rapidapi-key \
  --env SINYX_RAPIDAPI_HOST=sinyx.p.rapidapi.com \
  -- npx -y sinyx-mcp

Local Development

npm install
npm test

Create environment variables:

SINYX_API_BASE_URL=https://sinyx.p.rapidapi.com
SINYX_API_KEY=your-rapidapi-key
SINYX_API_KEY_HEADER=x-rapidapi-key
SINYX_RAPIDAPI_HOST=sinyx.p.rapidapi.com

You can also put these values in a local .env file. .env is ignored by Git.

cp .env.example .env

Run the local server:

npm start

Use a local checkout in MCP clients while developing:

{
  "mcpServers": {
    "sinyx": {
      "command": "node",
      "args": ["/absolute/path/to/sinyx-mcp/src/index.js"],
      "env": {
        "SINYX_API_BASE_URL": "https://sinyx.p.rapidapi.com",
        "SINYX_API_KEY": "your-rapidapi-key",
        "SINYX_API_KEY_HEADER": "x-rapidapi-key",
        "SINYX_RAPIDAPI_HOST": "sinyx.p.rapidapi.com"
      }
    }
  }
}

Live Check

After setting SINYX_API_KEY, verify the MCP wrapper against the live API:

npm run live:check

RapidAPI example in PowerShell:

$env:SINYX_API_BASE_URL="https://sinyx.p.rapidapi.com"
$env:SINYX_API_KEY="your-rapidapi-key"
$env:SINYX_API_KEY_HEADER="x-rapidapi-key"
$env:SINYX_RAPIDAPI_HOST="sinyx.p.rapidapi.com"
npm run live:check

Direct/private API example in PowerShell:

$env:SINYX_API_BASE_URL="https://api.sinyx.me"
$env:SINYX_API_KEY="your-direct-sinyx-key"
$env:SINYX_API_KEY_HEADER="x-sinyx-origin-key"
Remove-Item Env:SINYX_RAPIDAPI_HOST -ErrorAction SilentlyContinue
npm run live:check

Examples

Ready-to-edit examples are available in:

examples/mcp-client-config.rapidapi.json
examples/mcp-client-config.direct.json
examples/codex-config.toml
examples/claude-project-mcp.json
examples/cursor-project-mcp.json
examples/windsurf-mcp_config.json

For client-specific setup, see:

docs/client-setup.md

Notes

sinyx_status does not require a direct Sinyx key, but RapidAPI gateway calls may still need SINYX_API_KEY. Extraction tools always require SINYX_API_KEY.