Skip to main content
Glama

get_incident

Read-onlyIdempotent

Retrieve full details of a data quality incident by its ID, including severity, affected data types, root cause, resolution, and timeline.

Instructions

Get a specific data quality incident by its ID. Returns full incident details including severity, affected data types, root cause, resolution, and timeline.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesIncident ID (e.g., 'INC-2026-001')

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesResult data object

Implementation Reference

  • src/index.ts:2015-2026 (registration)
    Registration of the 'get_incident' tool via registerTool helper. Defines a single input param 'id' (string), uses ObjectOutputSchema, and calls the SDK's dataQuality.getIncident() as the handler.
    registerTool(
      "get_incident",
      "Get a specific data quality incident by its ID. Returns full incident details including severity, affected data types, root cause, resolution, and timeline.",
      {
        id: z.string().describe("Incident ID (e.g., 'INC-2026-001')"),
      },
      ObjectOutputSchema,
      async (params) => {
        const data = await api().dataQuality.getIncident(params.id);
        return formatResponse(data);
      }
    );
  • The inline handler function for 'get_incident'. Calls api().dataQuality.getIncident(params.id) and formats the response. The actual SDK method resolves via the OxArchive client from the @0xarchive/sdk package.
    async (params) => {
      const data = await api().dataQuality.getIncident(params.id);
      return formatResponse(data);
    }
  • Input schema for 'get_incident' — takes a single string parameter 'id' (the incident identifier).
      id: z.string().describe("Incident ID (e.g., 'INC-2026-001')"),
    },
    ObjectOutputSchema,
  • Output schema used by 'get_incident' — returns a single object with a 'data' field containing the incident details.
    const ObjectOutputSchema: ZodRawShape = {
      data: z.record(z.unknown()).describe("Result data object"),
    };
Behavior4/5

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

Annotations already declare readOnly, non-destructive, idempotent. Description adds specific fields returned (severity, root cause, etc.), providing useful behavioral context beyond 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 sentences, front-loaded with purpose, no wasted words. Informative and efficient.

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?

Tool has output schema, so description need not explain return values. Mentions key fields returned, making it complete for a simple get-by-ID tool.

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 has 100% coverage with a clear parameter description and example. Description adds no extra parameter information beyond schema.

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?

Clearly states verb 'Get' and resource 'specific data quality incident', distinguishes from sibling 'get_data_incidents' by specifying 'by its ID'. Mentions returned details.

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

Usage Guidelines4/5

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

Implicitly suggests use when full details of a specific incident are needed. Does not explicitly mention when not to use or name alternatives, but sibling list provides context.

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