Skip to main content
Glama
jerrelblankenship

Kibana MCP Server

export_dashboard

Export Kibana dashboards with all visualizations and data views for backup, sharing, or migration purposes.

Instructions

Export a dashboard with all its dependencies (visualizations, data views, etc.)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesDashboard ID to export
includeReferencesNoInclude all referenced objects (default: true)

Implementation Reference

  • MCP tool request handler for 'export_dashboard' which calls the Kibana client to export the dashboard.
    case 'export_dashboard': {
      const { id, includeReferences = true } = args as { id: string; includeReferences?: boolean };
      const exported = await kibanaClient.exportDashboard(
        id,
        includeReferences
      );
    
      return {
        content: [
          {
            type: 'text' as const,
            text: JSON.stringify(exported, null, 2),
          },
        ],
      };
    }
  • Actual implementation of the dashboard export logic, making an HTTP POST request to Kibana's API.
    async exportDashboard(
      dashboardId: string,
      includeReferencesDeep = true
    ): Promise<any> {
      const exportParams: ExportDashboardParams = {
        objects: [
          {
            type: 'dashboard',
            id: dashboardId,
          },
        ],
        includeReferencesDeep,
      };
    
      const response = await this.axiosInstance.post(
        '/api/saved_objects/_export',
        exportParams,
        {
          responseType: 'arraybuffer',
        }
      );
    
      // Parse NDJSON response
      const text = Buffer.from(response.data).toString('utf-8');
      const objects = text
        .split('\n')
        .filter((line) => line.trim())
        .map((line) => JSON.parse(line));
    
      return objects;
    }
  • Tool definition for 'export_dashboard' including input schema.
      name: 'export_dashboard',
      description:
        'Export a dashboard with all its dependencies (visualizations, data views, etc.)',
      inputSchema: {
        type: 'object',
        properties: {
          id: {
            type: 'string',
            description: 'Dashboard ID to export',
          },
          includeReferences: {
            type: 'boolean',
            description:
              'Include all referenced objects (default: true)',
            default: true,
          },
        },
        required: ['id'],
      },
    },
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions exporting with dependencies but doesn't cover critical aspects like output format (e.g., file type, download method), permissions required, whether it's a read-only or destructive operation, or any rate limits. This leaves significant gaps for an agent to understand the tool's behavior.

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?

The description is a single, efficient sentence with zero waste. It front-loads the core action and resource, and every word earns its place by specifying the scope ('with all its dependencies'). No unnecessary details or redundancy.

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

Completeness2/5

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

Given the complexity of an export operation with no annotations and no output schema, the description is incomplete. It lacks information on what the export produces (e.g., a file, JSON), how to handle the output, permissions, or error conditions. For a tool that likely involves data transformation and output, this is inadequate.

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 description coverage is 100%, so the schema already documents both parameters ('id' and 'includeReferences') thoroughly. The description adds no additional meaning beyond what the schema provides, such as clarifying dependency types or export implications. Baseline 3 is appropriate when the schema does the heavy lifting.

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

Purpose4/5

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

The description clearly states the action ('Export') and resource ('a dashboard'), including the scope of dependencies. It distinguishes from sibling tools like 'get_dashboard' or 'list_dashboards' by specifying an export operation rather than retrieval. However, it doesn't explicitly differentiate from potential export-related siblings if they existed.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing the dashboard ID), exclusions, or comparisons to sibling tools like 'get_dashboard' for viewing instead of exporting. Usage is implied but not explicitly stated.

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/jerrelblankenship/jb-kibana-mcp'

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