Skip to content

Gateway

The gateway (servers/gateway/) is an Express server that makes Crow's MCP servers accessible over HTTP with OAuth 2.1 authentication.

Modular Route Structure

The gateway entry point (servers/gateway/index.js, ~600 lines) is an ordered security narrative: the funnel/network-boundary middleware and the auth chain are wired inline, in a deliberate order that is the security model. Everything else is mounted from modules under servers/gateway/boot/:

Boot modulePurpose
boot/public-endpoints.jsPublic-safe endpoints (/health, .well-known, robots, manifest)
boot/mcp-mounts.jsAll MCP server mounts (per-server endpoints + the router)
boot/feature-mounts.jsFeature routes: backup admin, storage, blog, window manager, media
boot/admin-api.jsDashboard admin API routes
boot/peer-public-api.jsPeer/federation public API surface
boot/late-mounts.jsRoutes that must mount after the main stacks
boot/post-listen.jsPost-listen startup tasks + console summary

Core MCP transport logic is in routes/mcp.js, which exports the mountMcpServer() helper. Other route modules handle specific concerns:

ModulePurpose
routes/mcp.jsmountMcpServer() — mounts Streamable HTTP + SSE transports for any MCP server
routes/storage-http.jsFile upload (multipart) and download (presigned redirect) HTTP routes
routes/blog-public.jsPublic blog pages, tag pages, RSS and Atom feeds (no auth)
dashboard/Crow's Nest UI panels and auth system
session-manager.jsConsolidated session storage for all MCP servers (replaces per-server Maps)

Transports

mountMcpServer() Helper

All MCP servers are mounted via the mountMcpServer(router, prefix, createServer, sessionManager, authMiddleware, peerGate) function from routes/mcp.js. It registers both Streamable HTTP and SSE endpoints for a given server factory, using the consolidated SessionManager for session tracking. The optional peerGate is a default-deny exposure check applied to authenticated peer instances (federation): a remote instance can only reach servers the operator has explicitly exposed to it. Local operators (dashboard session, OAuth, or the local MCP token) bypass the peer gate.

Streamable HTTP (Primary)

Modern MCP transport used by most clients.

EndpointServer
POST|GET|DELETE /memory/mcpcrow-memory
POST|GET|DELETE /projects/mcpcrow-projects
POST|GET|DELETE /research/mcpcrow-projects (legacy alias)
POST|GET|DELETE /sharing/mcpcrow-sharing
POST|GET|DELETE /storage/mcpcrow-storage (conditional, requires MinIO)
POST|GET|DELETE /blog-mcp/mcpcrow-blog
POST|GET|DELETE /tools/mcpExternal tool proxy
POST|GET|DELETE /wm/mcpWindow manager (companion kiosk client; same auth chain as every other mount — local MCP token, OAuth, or exposure-gated peer)
POST|GET|DELETE /mcpcrow-memory (compatibility alias)

Sessions are managed via the mcp-session-id header. New sessions are created on initialize requests. Each transport gets an in-memory EventStore for resumability.

SSE (Legacy)

Legacy transport for ChatGPT and older clients.

EndpointPurpose
GET /memory/sseOpen SSE stream + create session
POST /memory/messagesSend messages to session
GET /projects/sseOpen SSE stream
POST /projects/messagesSend messages
GET /research/sseOpen SSE stream (legacy alias)
POST /research/messagesSend messages (legacy alias)
GET /sharing/sseOpen SSE stream
POST /sharing/messagesSend messages
GET /storage/sseOpen SSE stream (conditional)
POST /storage/messagesSend messages (conditional)
GET /blog-mcp/sseOpen SSE stream
POST /blog-mcp/messagesSend messages
GET /tools/sseOpen SSE stream
POST /tools/messagesSend messages

Sessions are identified by sessionId query parameter on message endpoints.

OAuth 2.1

The gateway implements OAuth 2.1 with Dynamic Client Registration:

RoutePurpose
GET /.well-known/oauth-authorization-serverOAuth metadata discovery
GET /.well-known/oauth-protected-resourceProtected resource metadata
POST /registerDynamic client registration
GET /authorizeAuthorization endpoint
POST /tokenToken endpoint
POST /introspectToken introspection

OAuth is backed by SQLite tables (oauth_clients, oauth_tokens) for persistence across restarts.

Run without auth for local development only:

bash
node servers/gateway/index.js --no-auth

Safety guard: The gateway refuses to start with --no-auth if CROW_GATEWAY_URL contains a public domain (e.g., .ts.net, .onrender.com, .fly.dev). This prevents accidental exposure of unauthenticated MCP endpoints via Tailscale Funnel or cloud hosting.

Integration Proxy

The proxy system (proxy.js + integrations.js) aggregates external MCP servers into the /tools/mcp endpoint:

  1. On startup, reads which API keys are present in environment variables
  2. For each configured integration, spawns the MCP server as a child process
  3. Connects via stdio transport and discovers available tools
  4. Prefixes tool names with the integration ID (e.g., github_create_issue)
  5. Exposes all tools through a single MCP endpoint

Adding a New Integration

Edit servers/gateway/integrations.js:

js
{
  id: "my-service",
  name: "My Service",
  description: "What it does",
  command: "npx",
  args: ["-y", "mcp-server-my-service"],
  envVars: ["MY_SERVICE_API_KEY"],
  keyUrl: "https://example.com/api-keys",
  keyInstructions: "How to get the key.",
}

Setup Page

GET /setup serves a mobile-friendly HTML page showing:

  • Connected integrations (green) with tool counts
  • Available integrations (gray) with setup links
  • MCP endpoint URLs for all supported transports
  • Quick setup instructions for each AI platform

No authentication required — doesn't expose secrets.

Security Considerations

  • Never use --no-auth in production — it disables all authentication. The gateway refuses --no-auth when NODE_ENV=production or when CROW_GATEWAY_URL contains a public domain
  • Always deploy behind HTTPS — Render and Railway provide this automatically. If self-hosting, use a reverse proxy (nginx, Caddy) with TLS, or Tailscale Funnel
  • The /setup page is unauthenticated by design — it only shows a password form (no secrets). Gate it with CROW_SETUP_TOKEN for hosted instances
  • /api/health is protected by dashboard session auth — it exposes system metrics (RAM, disk, CPU). The public /health endpoint returns only server status (no system info)
  • OAuth tokens are stored in the SQLite database and persist across restarts
  • Rate limiting is built in — 200 requests per 15 minutes (general) and 20 requests per 15 minutes (auth endpoints: /authorize, /token, /register). For high-traffic deployments, add additional rate limiting via your reverse proxy or hosting provider
  • SSE connections are capped — at most CROW_SSE_MAX (default 200) concurrent open streams across all eight SSE endpoints. Over the cap, the gateway responds 503 with Retry-After: 5 and releases all per-stream resources
  • A local MCP token (generated from the dashboard's Connect panel) authenticates local AI clients without the OAuth flow — verified server-side, hashed at rest, revocable from the same panel. See the Cross-Platform Guide
  • Content Security Policy restricts resource loading — allows Google Fonts (dashboard), same-origin scripts, and podcast media sources
  • The /crow.md endpoint is protected by OAuth when auth is enabled, since it exposes behavioral context

For the full public/private access model, see the Security Guide.

Router Mode

The /router/mcp endpoint exposes one consolidated category tool per server instead of the full raw tool surface (126+ tools across all servers). This is a major context-window reduction and the recommended way to connect an AI client.

On a full install the router registers 10 tools: 8 category tools (crow_memory, crow_projects, crow_blog, crow_sharing, crow_storage, crow_media, crow_orchestrator, crow_consulting) plus crow_tools (external integrations + remote instances) and crow_discover (schema lookup). Storage, media, and orchestrator categories appear only when their backing service or bundle is available. Each category tool dispatches to the underlying server via an in-process MCP Client. The crow_discover tool returns full schemas on demand, so clients can inspect available actions without loading all tool definitions upfront. The crow_research name is accepted as a backward-compatible alias for crow_projects.

Router mode is backward compatible — existing per-server endpoints (/memory/mcp, /research/mcp, etc.) remain unchanged and continue to work as before. The router is an additional endpoint, not a replacement.

To disable router mode, set the environment variable CROW_DISABLE_ROUTER=1.

For the full reference, see Context Management.

Chat API

The gateway includes a built-in AI Chat system (/api/chat/*) that turns Crow into an AI client. This powers the BYOAI Chat feature in the Crow's Nest. All chat routes are protected by dashboard session auth (cookie-based).

Routes

MethodEndpointPurpose
POST/api/chat/conversationsCreate a new conversation
GET/api/chat/conversationsList conversations (paginated)
GET/api/chat/conversations/:idGet conversation with all messages
DELETE/api/chat/conversations/:idDelete conversation (cascades to messages)
POST/api/chat/conversations/:id/messagesSend message, receive SSE stream
POST/api/chat/conversations/:id/cancelCancel in-progress generation
GET/api/chat/providersList available providers and current config
POST/api/chat/providers/testTest provider connection

Provider Adapter Pattern

The AI provider layer (ai/provider.js) uses a registry of lazy-loaded adapters:

ProviderAdapterAPI Format
openaiai/adapters/openai.jsOpenAI Chat Completions (also OpenRouter, vLLM, LM Studio)
anthropicai/adapters/anthropic.jsAnthropic Messages API
googleai/adapters/google.jsGoogle Gemini REST API
ollamaai/adapters/ollama.jsOllama native /api/chat

Each adapter implements a chatStream(messages, tools, options) method that returns an async iterator yielding events: content_delta (text chunks), tool_call (function calls), and done (usage stats). Provider config is hot-reloaded from .env with a 5-second cache.

Tool Executor Pattern

When the AI responds with tool calls, the tool executor (ai/tool-executor.js) dispatches them to Crow's MCP servers:

  1. The executor maintains a pool of lazy in-process MCP Clients, one per server category
  2. Each client connects to its server factory via InMemoryTransport (same pattern as the tool router)
  3. Tool calls are resolved by category — crow_memory routes to the memory server, crow_projects to the project server, etc.
  4. The AI sees the router-style category tools (the executor dispatches the memory, projects, blog, sharing, storage, and media categories), plus crow_tools, crow_discover for schema lookup, and explicit orchestration tools
  5. Results are truncated to 2000 characters to prevent context overflow
  6. Up to 10 tool call rounds per message turn (the AI can call tools, get results, and call more tools)
User Message
  → AI Provider API (streaming)
    → content_delta events → SSE to browser
    → tool_call events → Tool Executor
      → InMemoryTransport → MCP Server → Database
      → result → back to AI for next round
  → done event → SSE to browser

Tool results and assistant messages are persisted to chat_messages with token counts. Conversations track total tokens for usage monitoring.

Rate Limiting

Chat messages are rate-limited to 10 messages per minute per session (separate from the gateway's general rate limiter). Active generations can be cancelled via the cancel endpoint or by the client disconnecting.

Graceful Shutdown

On SIGTERM/SIGINT the gateway runs a staged drain instead of exiting immediately: it stops the scheduler (so no new background ticks fire during teardown), stops accepting new connections, gives in-flight requests up to CROW_SHUTDOWN_DRAIN_MS (default 3000 ms) to finish, severs remaining sockets (long-lived SSE streams reconnect after restart), shuts down MCP sessions and proxy children, and finally checkpoints the SQLite WAL best-effort before exiting. This minimizes mid-operation kills during deploys and restarts. A monitor polling /health may see refusals for up to the drain window — that's the expected restart behavior.

Health Check

GET /health returns JSON status:

json
{
  "status": "ok",
  "servers": ["crow-memory", "crow-projects", "crow-sharing", "crow-storage", "crow-blog"],
  "externalServers": [{"id": "github", "name": "GitHub", "tools": 15}]
}

System resource metrics (RAM, disk, CPU) are available at GET /api/health, protected by dashboard session auth.

Federation

The gateway can proxy tool calls to remote Crow instances via HTTP. When an instance is registered in the crow_instances table with a gateway_url, the proxy layer connects using the MCP SDK's StreamableHTTPClientTransport and makes remote tools available through the crow_tools router action with an instance_id parameter. See Multi-Instance Architecture for sync, conflict resolution, and security details.

Released under the MIT License.