Skip to main content
Glama

get_data_incidents

Read-onlyIdempotent

List data quality incidents with filters for status, exchange, or time. Get severity, duration, root cause, and resolution details.

Instructions

List data quality incidents (outages, gaps, degradations). Filter by status, exchange, or time. Returns incident details including severity, affected data types, duration, root cause, and resolution.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusNoFilter incidents by status
exchangeNoVenue scope
sinceNoOnly incidents after this time (Unix ms or ISO)
limitNoMax results (default 20, max 100)
offsetNoPagination offset

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesResult data object

Implementation Reference

  • src/index.ts:1916-2012 (registration)
    The tool 'get_data_incidents' is registered using the registerTool helper on lines 1989-2012. It takes optional filter parameters (status, exchange, since, limit, offset) and calls api().dataQuality.listIncidents() to list data quality incidents.
    const ExchangeParam = z
      .enum(["hyperliquid", "lighter", "hip3"])
      .optional()
      .describe("Venue scope");
    
    const IncidentStatusParam = z
      .enum(["open", "investigating", "identified", "monitoring", "resolved"])
      .optional()
      .describe("Filter incidents by status");
    
    // 30. System Status
    registerTool(
      "get_data_quality_status",
      "Get the current system status for supported venue APIs and data types. Returns overall health (operational/degraded/outage), per-scope status with latency, per-data-type completeness, and active incident count.",
      {},
      ObjectOutputSchema,
      async () => {
        const data = await api().dataQuality.status();
        return formatResponse(data);
      }
    );
    
    // 30. Coverage Overview
    registerTool(
      "get_data_coverage",
      "Get data coverage across supported venue APIs. Returns earliest/latest timestamps, total records, symbol count, resolution, lag, and completeness per data type per venue scope.",
      {},
      ObjectOutputSchema,
      async () => {
        const data = await api().dataQuality.coverage();
        return formatResponse(data);
      }
    );
    
    // Exchange Coverage
    registerTool(
      "get_exchange_coverage",
      "Get data coverage for a specific venue scope. Returns earliest/latest timestamps, total records, symbol count, resolution, and completeness per data type.",
      {
        exchange: z.enum(["hyperliquid", "lighter", "hip3"]).describe("Venue scope"),
      },
      ObjectOutputSchema,
      async (params) => {
        const data = await api().dataQuality.exchangeCoverage(params.exchange);
        return formatResponse(data);
      }
    );
    
    // 31. Symbol Coverage
    registerTool(
      "get_symbol_coverage",
      "Get detailed data coverage for a specific symbol on a venue scope. Returns per-data-type coverage with earliest/latest, total records, completeness, detected data gaps, and cadence metrics.",
      {
        exchange: z.enum(["hyperliquid", "lighter", "hip3"]).describe("Venue scope"),
        symbol: z.string().describe("Symbol, e.g. 'BTC', 'ETH', 'km:US500'"),
        from: TimestampParam.describe("Start of gap detection window (Unix ms or ISO). Defaults to 30 days ago."),
        to: TimestampParam.describe("End of gap detection window (Unix ms or ISO). Defaults to now."),
      },
      ObjectOutputSchema,
      async (params) => {
        const options: Record<string, unknown> = {};
        if (params.from != null) options.from = toUnixMs(params.from);
        if (params.to != null) options.to = toUnixMs(params.to);
        const data = await api().dataQuality.symbolCoverage(
          params.exchange,
          params.symbol,
          Object.keys(options).length > 0 ? options as any : undefined
        );
        return formatResponse(data);
      }
    );
    
    // 32. Incidents
    registerTool(
      "get_data_incidents",
      "List data quality incidents (outages, gaps, degradations). Filter by status, exchange, or time. Returns incident details including severity, affected data types, duration, root cause, and resolution.",
      {
        status: IncidentStatusParam,
        exchange: ExchangeParam,
        since: TimestampParam.describe("Only incidents after this time (Unix ms or ISO)"),
        limit: z.number().optional().describe("Max results (default 20, max 100)"),
        offset: z.number().optional().describe("Pagination offset"),
      },
      ObjectOutputSchema,
      async (params) => {
        const sdkParams: Record<string, unknown> = {};
        if (params.status) sdkParams.status = params.status;
        if (params.exchange) sdkParams.exchange = params.exchange;
        if (params.since != null) sdkParams.since = typeof params.since === "string" ? toUnixMs(params.since) : params.since;
        if (params.limit) sdkParams.limit = params.limit;
        if (params.offset) sdkParams.offset = params.offset;
        const data = await api().dataQuality.listIncidents(
          Object.keys(sdkParams).length > 0 ? sdkParams as any : undefined
        );
        return formatResponse(data);
      }
    );
  • Schema definitions for the incident status enum (IncidentStatusParam) and exchange enum (ExchangeParam) used as input schema for get_data_incidents.
    const ExchangeParam = z
      .enum(["hyperliquid", "lighter", "hip3"])
      .optional()
      .describe("Venue scope");
    
    const IncidentStatusParam = z
      .enum(["open", "investigating", "identified", "monitoring", "resolved"])
      .optional()
      .describe("Filter incidents by status");
  • Supporting schemas and the registerTool helper (lines 328-358) used to register get_data_incidents.
    const ExchangeParam = z
      .enum(["hyperliquid", "lighter", "hip3"])
      .optional()
      .describe("Venue scope");
    
    const IncidentStatusParam = z
      .enum(["open", "investigating", "identified", "monitoring", "resolved"])
      .optional()
      .describe("Filter incidents by status");
    
    // 30. System Status
    registerTool(
      "get_data_quality_status",
      "Get the current system status for supported venue APIs and data types. Returns overall health (operational/degraded/outage), per-scope status with latency, per-data-type completeness, and active incident count.",
      {},
      ObjectOutputSchema,
      async () => {
        const data = await api().dataQuality.status();
        return formatResponse(data);
      }
    );
  • The registerTool helper function that wraps server.registerTool with API key validation and error handling.
    function registerTool(
      name: string,
      description: string,
      inputSchema: ZodRawShape,
      outputSchema: ZodRawShape,
      handler: (params: any) => Promise<McpContent>
    ): void {
      server.registerTool(
        name,
        {
          description,
          inputSchema,
          outputSchema,
          annotations: TOOL_ANNOTATIONS,
        },
        async (params: any) => {
          if (!client) {
            return {
              content: [{ type: "text" as const, text: MISSING_KEY_MESSAGE }],
              isError: true,
            };
          }
          try {
            return await handler(params);
          } catch (err) {
            const error = err instanceof OxArchiveError ? err : new OxArchiveError(String(err), 500);
            return formatError(error);
          }
        }
      );
    }
  • The handler function (lines 2000-2011) that collects optional filter params (status, exchange, since, limit, offset), builds an SDK params object, and calls api().dataQuality.listIncidents() to fetch and return incident data.
    const ExchangeParam = z
      .enum(["hyperliquid", "lighter", "hip3"])
      .optional()
      .describe("Venue scope");
    
    const IncidentStatusParam = z
      .enum(["open", "investigating", "identified", "monitoring", "resolved"])
      .optional()
      .describe("Filter incidents by status");
    
    // 30. System Status
    registerTool(
      "get_data_quality_status",
      "Get the current system status for supported venue APIs and data types. Returns overall health (operational/degraded/outage), per-scope status with latency, per-data-type completeness, and active incident count.",
      {},
      ObjectOutputSchema,
      async () => {
        const data = await api().dataQuality.status();
        return formatResponse(data);
      }
    );
    
    // 30. Coverage Overview
    registerTool(
      "get_data_coverage",
      "Get data coverage across supported venue APIs. Returns earliest/latest timestamps, total records, symbol count, resolution, lag, and completeness per data type per venue scope.",
      {},
      ObjectOutputSchema,
      async () => {
        const data = await api().dataQuality.coverage();
        return formatResponse(data);
      }
    );
    
    // Exchange Coverage
    registerTool(
      "get_exchange_coverage",
      "Get data coverage for a specific venue scope. Returns earliest/latest timestamps, total records, symbol count, resolution, and completeness per data type.",
      {
        exchange: z.enum(["hyperliquid", "lighter", "hip3"]).describe("Venue scope"),
      },
      ObjectOutputSchema,
      async (params) => {
        const data = await api().dataQuality.exchangeCoverage(params.exchange);
        return formatResponse(data);
      }
    );
    
    // 31. Symbol Coverage
    registerTool(
      "get_symbol_coverage",
      "Get detailed data coverage for a specific symbol on a venue scope. Returns per-data-type coverage with earliest/latest, total records, completeness, detected data gaps, and cadence metrics.",
      {
        exchange: z.enum(["hyperliquid", "lighter", "hip3"]).describe("Venue scope"),
        symbol: z.string().describe("Symbol, e.g. 'BTC', 'ETH', 'km:US500'"),
        from: TimestampParam.describe("Start of gap detection window (Unix ms or ISO). Defaults to 30 days ago."),
        to: TimestampParam.describe("End of gap detection window (Unix ms or ISO). Defaults to now."),
      },
      ObjectOutputSchema,
      async (params) => {
        const options: Record<string, unknown> = {};
        if (params.from != null) options.from = toUnixMs(params.from);
        if (params.to != null) options.to = toUnixMs(params.to);
        const data = await api().dataQuality.symbolCoverage(
          params.exchange,
          params.symbol,
          Object.keys(options).length > 0 ? options as any : undefined
        );
        return formatResponse(data);
      }
    );
    
    // 32. Incidents
    registerTool(
      "get_data_incidents",
      "List data quality incidents (outages, gaps, degradations). Filter by status, exchange, or time. Returns incident details including severity, affected data types, duration, root cause, and resolution.",
      {
        status: IncidentStatusParam,
        exchange: ExchangeParam,
        since: TimestampParam.describe("Only incidents after this time (Unix ms or ISO)"),
        limit: z.number().optional().describe("Max results (default 20, max 100)"),
        offset: z.number().optional().describe("Pagination offset"),
      },
      ObjectOutputSchema,
      async (params) => {
        const sdkParams: Record<string, unknown> = {};
        if (params.status) sdkParams.status = params.status;
        if (params.exchange) sdkParams.exchange = params.exchange;
        if (params.since != null) sdkParams.since = typeof params.since === "string" ? toUnixMs(params.since) : params.since;
        if (params.limit) sdkParams.limit = params.limit;
        if (params.offset) sdkParams.offset = params.offset;
        const data = await api().dataQuality.listIncidents(
          Object.keys(sdkParams).length > 0 ? sdkParams as any : undefined
        );
        return formatResponse(data);
      }
    );
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true. The description adds that results include severity, duration, etc., but does not disclose additional behavioral traits like rate limits or auth requirements. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two concise sentences with front-loaded purpose, filtering options, and return details. Every sentence adds value without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With a complete output schema and 5 optional parameters (2 with enums), the description sufficiently covers the tool's functionality. No critical gaps remain for a list endpoint.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with all 5 parameters described. The description reinforces filtering by status, exchange, and time but does not add new semantic meaning beyond what the schema provides. Pagination parameters (limit, offset) are omitted from the description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'List' and the resource 'data quality incidents', providing concrete examples (outages, gaps, degradations) and mentioning return fields. It distinguishes from siblings like get_data_coverage by focusing on incidents specifically.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies filtering capabilities but does not explicitly state when to use this tool vs alternatives like get_incident (singular). No 'when not to use' or comparative guidance is provided.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/0xArchiveIO/0xarchive-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server