Insight Tool

1. Overview

Connect an MCP-compatible AI client to InsightSentry with @insightsentry/mcp.

The package also includes the insight CLI for terminal commands and scripts.

2. Setup

Prerequisites

Install Node.js 18 or newer and get your API key from the Dashboard.

Claude Code

claude mcp add insightsentry \
  --env INSIGHTSENTRY_API_KEY=your-api-key \
  -- npx -y @insightsentry/mcp

Codex CLI

codex mcp add insightsentry \
  --env INSIGHTSENTRY_API_KEY=your-api-key \
  -- npx -y @insightsentry/mcp

Run codex mcp list to verify the server was saved.

opencode

Choose a local server in the MCP wizard:

opencode mcp add

# Use these values when prompted:
# Name: insightsentry
# Type: local
# Command: npx -y @insightsentry/mcp
# Environment: INSIGHTSENTRY_API_KEY=your-api-key

Run opencode mcp list to confirm the server is configured.

OpenClaw

openclaw mcp set insightsentry '{"command":"npx","args":["-y","@insightsentry/mcp"],"env":{"INSIGHTSENTRY_API_KEY":"your-api-key"}}'

Run openclaw mcp list to confirm the saved entry.

Other MCP Clients

Configure your client to run:

INSIGHTSENTRY_API_KEY=your-api-key npx -y @insightsentry/mcp

3. Verify

Restart the client, then try:

Use search_symbols to find standard codes, such as NASDAQ:AAPL, and list_sip_symbols to find supported SIP codes.

4. Optional CLI

Install the insight, insight-mcp, and mcp commands:

npm install -g @insightsentry/mcp

Authentication

The CLI can use INSIGHTSENTRY_API_KEY or a saved key from insight login. Environment variables take priority.

# Save a key for CLI use
insight login

# Or use a key only for the current shell
export INSIGHTSENTRY_API_KEY="your-api-key"

# Remove the saved key
insight logout

Common Commands

# See available commands
insight --help

# Get help for a specific tool
insight <tool> --help

# List exchange prefixes, then search within one exchange
insight list_exchanges
insight search_symbols --exchange NASDAQ --type stock

# List supported SIP symbols
insight list_sip_symbols --filter 'symbols[code="SIP:AAPL"]'

# Query quotes
insight get_quotes --codes "NASDAQ:AAPL,NASDAQ:MSFT"

# Download historical bars
insight download_history --symbol "NASDAQ:AAPL" --bar_type day \
  --from 2024-01-01 --to 2024-06-30 --output_dir ./history

# Read document text (the default)
insight get_document --id "report:example" --code "NASDAQ:AAPL"

# Save a PDF document
insight get_document --id "report:example" --code "NASDAQ:AAPL" --text false --output_file ./report.pdf

# Stream real-time quotes as NDJSON
insight stream_live --symbols "NASDAQ:AAPL,NASDAQ:MSFT" --type quote   --max_messages 100 --duration_seconds 30 --quiet

# Append live news to a file for 30 minutes
insight stream_newsfeed --content "earnings" --output_file ./news.ndjson --append \
  --duration_seconds 1800

Most API tools also support --filter <jsonata> to transform JSON output before printing it.

get_document defaults to text=true and returns {title, published_at, content}. With text=false, PDF documents are saved to output_file or output_dir and return {stored_file, format, mime_type}. The default destination is ./.tmp/insight. Non-PDF documents still return JSON. Use text mode for filtering or JSON storage.

History downloads report a CLI failure or MCP error if any chunk fails. Retry the same command to resume; failed runs keep downloaded chunks and preserve the last complete CSV. Futures second-bar downloads use the selected dates. Cancel a request from your MCP client or press Ctrl+C in the CLI to stop it.

Run stream commands without flags for guided setup. With flags, they never prompt. Data goes to stdout or --output_file; --tee writes to both. Status and errors go to stderr; --quiet suppresses status messages. Limit a run with --duration_seconds or --max_messages. Authenticate the terminal separately from your MCP client using insight login or INSIGHTSENTRY_API_KEY.

5. Tool Coverage

Use insight --help or your MCP client's tool list for arguments.

Use collect_live or collect_newsfeed for live MCP requests. Both return structured data and stop after 20 messages or 10 seconds by default. The maximum is 100 messages or 60 seconds, whichever comes first. A response-size limit may stop a call earlier. Check activated and stop_reason; activation_timeout means the subscription did not become active before the duration limit. Tool text is a short summary, while message data remains in the structured result.

6. Docs Resources

Your MCP client can read these documentation resources:

7. Examples