1. Overview
@insightsentry/mcp connects MCP-compatible AI clients to the InsightSentry API. It lets an assistant search symbols, query market data, screen instruments, inspect options, read documentation resources, render charts, and download history files.
The npm package also includes the insight terminal CLI. Use MCP for AI client workflows and use the CLI when you want direct shell commands or scripts.
| Mode | Use it for |
|---|---|
| MCP server | AI assistants that need live market data or built-in InsightSentry docs. |
| insight CLI | Terminal lookups, scripts, file downloads, and JSON filtering. |
2. Setup
Prerequisites
Install Node.js 18 or newer and get your API key from the Dashboard.
Claude Code
Claude Code can add the npm package directly from the terminal:
claude mcp add insightsentry \
--env INSIGHTSENTRY_API_KEY=your-api-key \
-- npx -y @insightsentry/mcpThis writes the same stdio server configuration for you.
Codex CLI
Codex can add the npm package as a local stdio MCP server:
codex mcp add insightsentry \
--env INSIGHTSENTRY_API_KEY=your-api-key \
-- npx -y @insightsentry/mcpRun codex mcp list to verify the server was saved.
opencode
Use the opencode MCP wizard and choose a local server:
opencode mcp add
# Use these values when prompted:
# Name: insightsentry
# Type: local
# Command: npx -y @insightsentry/mcp
# Environment: INSIGHTSENTRY_API_KEY=your-api-keyRun opencode mcp list to confirm the server is configured.
OpenClaw
Use OpenClaw's MCP config command to save the npm stdio server:
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
Any MCP-compatible client can also start the npm package through stdio. Configure the client to run:
INSIGHTSENTRY_API_KEY=your-api-key npx -y @insightsentry/mcp3. Verify
After the client restarts, ask it to use the InsightSentry server for a small request:
"Use InsightSentry to find the symbol for Apple and get the latest quote."
If the assistant does not know the exact InsightSentry symbol code, ask it to call search_symbols first. InsightSentry uses codes such as NASDAQ:AAPL, which can differ from ticker formats on other platforms.
MCP clients choose when to call tools. Clear prompts work best when they name the desired data and whether the assistant should search for the symbol first.
4. Optional CLI
Install globally if you want the insight, insight-mcp, and mcp commands available in your shell.
npm install -g @insightsentry/mcpAuthentication
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 logoutCommon Commands
# See available commands
insight --help
# Get help for a specific tool
insight <tool> --help
# 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 ./historyMost API tools also support --filter <jsonata> to transform JSON output before printing it.
5. Tool Coverage
The MCP server exposes the same core market-data workflows as the CLI. Use insight --helpor your MCP client's tool list for exact argument schemas.
Market data
| Tool | Purpose |
|---|---|
| search_symbols | Find InsightSentry symbol codes by name or ticker. |
| get_quotes | Get real-time quotes for up to 10 symbols. |
| get_symbol_series | Get recent OHLCV bars, with optional real-time data. |
| get_symbol_history | Fetch deeper historical OHLCV ranges. |
| get_symbol_info | Read symbol metadata, market data, splits, and option info. |
| get_symbol_session | Inspect trading sessions and market hours. |
| get_symbol_contracts | List futures contracts and settlement dates. |
| get_symbol_fundamentals | Get company valuation, income, and balance-sheet data. |
| get_fundamentals_series | Fetch historical fundamental indicators. |
| get_fundamentals_meta | Discover available fundamental and technical indicators. |
Screeners
| Tool | Purpose |
|---|---|
| screen_stocks | Filter stocks with custom fields, exchanges, and sort order. |
| screen_etfs | Filter ETFs with custom fields, exchanges, and sort order. |
| screen_bonds | Filter bonds with custom fields, countries, and sort order. |
| screen_crypto | Filter crypto assets with custom fields and sort order. |
| get_*_screener_params | Discover valid fields and filters for each screener. |
Options
| Tool | Purpose |
|---|---|
| get_options_contracts | Discover available option contract codes and metadata. |
| get_options_snapshot | Get latest option bars, quotes, and trades in one response. |
| get_options_quotes | Get option quote rows with bid/ask, Greeks, and implied volatility. |
Calendars, news, and documents
| Tool | Purpose |
|---|---|
| get_dividends | Read dividend calendar data. |
| get_earnings | Read earnings calendar data. |
| get_ipos | Read IPO calendar data. |
| get_events | Read economic event calendar data. |
| get_newsfeed | Search financial news. |
| get_documents | List SEC filings and transcripts for a symbol. |
| get_document | Read a specific document. |
Files and charts
| Tool | Purpose |
|---|---|
| download_history | Download date ranges as local CSV or JSON files. |
| render_chart | Render Chart.js configurations as PNG images. |
6. Docs Resources
The server includes documentation resources that MCP clients can read while helping you build against the REST API and WebSocket feeds.
| Resource | Content |
|---|---|
| insightsentry://docs | Documentation index with API guides and references. |
| insightsentry://docs/parameters | Common parameters for adjustments, sessions, and bars. |
| insightsentry://docs/ws | WebSocket connection, subscriptions, and data formats. |
| insightsentry://docs/mcp | CLI and MCP setup for AI assistants. |
| insightsentry://docs/screener | Screener fields, filters, and discovery patterns. |
| insightsentry://docs/options | Option chains, Greeks, and option code format. |
| insightsentry://docs/organization | Organization API members, plans, and credits. |
| insightsentry://docs/archive | Historical data endpoints, bar types, and archive ranges. |
| insightsentry://docs/futures-history | Futures contract month handling and history downloads. |
| insightsentry://docs/scalability | Scaling approaches with custom plans and data packages. |
| insightsentry://docs/enterprise | Enterprise WebSocket and Pub/Sub data packages. |
7. Examples
Useful prompts are specific about the symbol, data type, and output.
- "Find the correct InsightSentry symbol for Apple, then get the latest quote and company fundamentals."
- "Screen US stocks with market cap above $100B, sorted by volume."
- "Show the options chain for AAPL expiring next month."
- "Help me build a Python WebSocket client that streams real-time quotes."
- "Download AAPL minute bars from January through June 2024 as a merged CSV."