Skip to main content
Glama
turbot
by turbot

steampipe_plugin_show

Retrieve installation details for a Steampipe plugin, including version, memory limits, and configuration settings.

Instructions

Get details for a specific Steampipe plugin installation, including version, memory limits, and configuration.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesName of the plugin to show details for

Implementation Reference

  • The async handler function that implements the core logic of the steampipe_plugin_show tool, querying the Steampipe database for plugin details based on the provided name.
    handler: async (db: DatabaseService, args: { name: string }) => {
      if (!db) {
        return {
          content: [{
            type: "text",
            text: "Database not available. Please ensure Steampipe is running and try again."
          }],
          isError: true
        };
      }
    
      try {
        const query = `
          SELECT 
            plugin_instance,
            plugin,
            version,
            memory_max_mb,
            limiters,
            file_name,
            start_line_number,
            end_line_number
          FROM steampipe_plugin
          WHERE plugin = $1
        `;
    
        const result = await db.executeQuery(query, [args.name]);
        
        if (result.length === 0) {
          return {
            content: [{
              type: "text",
              text: `Plugin '${args.name}' not found`
            }],
            isError: true
          };
        }
    
        return {
          content: [{
            type: "text",
            text: JSON.stringify({ plugin: result[0] })
          }]
        };
      } catch (err) {
        logger.error("Error showing plugin details:", err);
        return {
          content: [{
            type: "text",
            text: `Failed to get plugin details: ${err instanceof Error ? err.message : String(err)}`
          }],
          isError: true
        };
      }
    }
  • Input schema defining the parameters for the steampipe_plugin_show tool, requiring a 'name' string.
    inputSchema: {
      type: "object",
      properties: {
        name: {
          type: "string",
          description: "Name of the plugin to show details for"
        }
      },
      required: ["name"],
      additionalProperties: false
    },
  • Registration of the imported steampipe_plugin_show tool in the central tools export object used by the MCP server.
    steampipe_plugin_show: pluginShowTool as DbTool,
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 what details are returned (version, memory limits, configuration) but does not cover other important aspects such as error handling (e.g., what happens if the plugin doesn't exist), permissions required, or whether it's a read-only operation. This leaves significant gaps for a tool with no annotation coverage.

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, well-structured sentence that efficiently conveys the tool's purpose and key details. It is front-loaded with the main action and resource, and every part of the sentence adds value without redundancy or unnecessary information.

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

Completeness3/5

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

Given the tool's complexity (simple read operation with one parameter) and the lack of annotations and output schema, the description is moderately complete. It specifies what details are retrieved, but it does not fully compensate for the missing behavioral context (e.g., error handling, permissions) or describe the return format, which would be needed for higher completeness in the absence of an output schema.

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?

The schema description coverage is 100%, with the parameter 'name' clearly documented in the schema as 'Name of the plugin to show details for.' The description does not add any additional meaning or context beyond what the schema provides, such as format examples or constraints. With high schema coverage, the baseline score of 3 is appropriate.

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 specific action ('Get details') and resource ('a specific Steampipe plugin installation'), distinguishing it from siblings like 'steampipe_plugin_list' (which lists all plugins) and 'steampipe_table_show' (which shows table details). It explicitly mentions what details are included: version, memory limits, and configuration.

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?

The description implies usage context by specifying 'a specific Steampipe plugin installation,' suggesting it should be used when details for a particular plugin are needed. However, it does not explicitly state when not to use it or name alternatives like 'steampipe_plugin_list' for listing all plugins, which would be required for a score of 5.

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/turbot/steampipe-mcp'

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