Skip to main content
Glama

cribl_getPipelines

Retrieves pipeline definitions from a specified worker group, enabling configuration management and inspection of Cribl data processing logic.

Instructions

Fetches pipeline definitions in a specified worker group.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
groupNameNoOptional: The name of the Worker Group/Fleet. If omitted, defaults to attempting to use Cribl Stream and if only one group exists for Stream, it will use that sole group.

Implementation Reference

  • Zod schema for cribl_getPipelines arguments - defines optional groupName parameter using GroupNameArgSchema.
    // Define schema for getPipelines arguments (groupName optional)
    const GetPipelinesArgsShape = {
        groupName: GroupNameArgSchema,
    };
  • MCP tool handler for 'cribl_getPipelines' - resolves the group name, calls the getPipelines API client function, and returns the pipeline definitions as JSON.
    server.tool(
        'cribl_getPipelines',
        'Fetches pipeline definitions in a specified worker group.',
        GetPipelinesArgsShape,
        async (args: ValidatedArgs<typeof GetPipelinesArgsShape>) => {
            console.error(`[Tool Call] cribl_getPipelines with args:`, args);
            const groupResolution = await resolveGroupName(args.groupName); // Pass directly, preprocess handles null
            if (groupResolution.error || !groupResolution.groupName) {
                return { isError: true, content: [{ type: 'text', text: groupResolution.error || 'Could not determine group name.' }] };
            }
            const groupName = groupResolution.groupName;
    
            const result = await getPipelines(groupName);
            if (!result.success) {
                console.error(`[Tool Error] cribl_getPipelines (Group: ${groupName}):`, result.error);
                return {
                    isError: true,
                    content: [{ type: 'text', text: `Error fetching pipelines for group ${groupName}: ${result.error}` }],
                };
            }
            console.error(`[Tool Success] cribl_getPipelines (Group: ${groupName}): Found ${result.data?.length || 0} pipelines.`);
            return {
                content: [{ type: 'text', text: JSON.stringify(result.data || [], null, 2) }],
            };
        }
    );
  • src/server.ts:145-146 (registration)
    Registration of the 'cribl_getPipelines' tool via server.tool(), binding the name, description, schema, and handler.
    server.tool(
        'cribl_getPipelines',
  • The getPipelines API client function that performs the actual HTTP GET request to /api/v1/m/{groupName}/pipelines and returns the pipeline items array.
    export async function getPipelines(groupName: string): Promise<ClientResult<CriblPipeline[]>> {
        const context = `getPipelines (Group: ${groupName})`;
        if (!groupName) {
            return { success: false, error: 'Group name is required for getPipelines.' };
        }
        // Use group-specific path
        const url = `/api/v1/m/${groupName}/pipelines`;
        console.error(`[stderr] Attempting API call: GET ${url}`);
        try {
            const response = await apiClient.get<CriblApiResponse>(url);
            return { success: true, data: response.data.items as CriblPipeline[] };
        } catch (error) {
            const errorMessage = handleApiError(error, context);
            return { success: false, error: errorMessage };
        }
    }
Behavior2/5

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

With no annotations, the description should disclose behavioral traits. It states it fetches data (implying read-only) but does not explicitly confirm safety, idempotence, or any side effects. No mention of permissions or rate limits.

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, concise sentence that front-loads the core purpose without any fluff.

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 no output schema, the description should hint at return format or content, but it does not. It also does not clarify how this differs from similar sibling tools, leaving the agent with incomplete context.

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% and the schema already explains the parameter well. The tool description adds no additional semantics beyond what is in the schema, so 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 action (fetches), resource (pipeline definitions), and context (in a specified worker group), distinguishing it from sibling tools like cribl_getPipelineConfig which retrieves config, not definitions.

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 does not provide any guidance on when to use this tool versus alternatives like cribl_getPipelineConfig or cribl_getSources, nor does it mention prerequisites or 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/pebbletek/cribl-mcp'

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