Skip to content

Tools Reference

Michael Carey edited this page Mar 18, 2026 · 1 revision

Tools Reference

seq-mcp exposes tools in two layers:

  • Starter tools for common read workflows.
  • Broad API tools for full route coverage.

Starter Tools

Use these first for safe, common tasks.

  • seq_connection_test: validates connectivity and API reachability.
  • seq_starter_help: lists compact starter aliases.
  • seq_starter_overview: quick health, user, diagnostics, and workspace summary.
  • seq_starter_events_search: search events by filter/signal/time range.
  • seq_starter_event_by_id: fetch one event by id.
  • seq_starter_data_query: run a q query using GET or POST.
  • seq_starter_signals_list: list signals.
  • seq_starter_signal_by_id: fetch one signal by id.
  • seq_starter_dashboards_list: list dashboards.
  • seq_starter_alerts_list: list alerts.
  • seq_starter_events_stream: bounded live-tail style stream call.

Catalog and Generic API Tools

Use these when you need broader Seq API surface access.

  • seq_api_catalog: returns official route/verb/permission catalog.
  • seq_api_live_links: discovers live name -> route links from your Seq instance.
  • seq_api_request: generic verb/path invoker.
  • seq_<verb>_<route>: auto-generated tool per official route and verb.

Choosing the Right Tool

  • Use starter tools for dashboards, events, signals, and basic diagnostics.
  • Use seq_api_catalog before broad operations to confirm route and required permission.
  • Use seq_api_request or generated tools only when starter tools do not cover your scenario.

Scope and Safety Notes

  • seq_starter_* tools focus on common read operations.
  • seq_api_request and seq_<verb>_<route> can include non-GET routes.
  • Always match API key permissions to the exact route usage.

Reference Docs

See also: Security and Troubleshooting.

Clone this wiki locally