Skip to main content
Glama

Pipes Describe Pipe

pipes_describe_pipe
Read-onlyIdempotent

Retrieve a Snowflake pipe's definition and COPY statement by pipe name to inspect ingestion configuration and troubleshoot data loading pipelines.

Instructions

Describe pipe definition and COPY statement.

Input Schema

NameRequiredDescriptionDefault
databaseNoQuote names that aren't all uppercase, exactly as list tools return them.
pipe_nameYesQuote names that aren't all uppercase, exactly as list tools return them.
schema_nameNoQuote names that aren't all uppercase, exactly as list tools return them.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv3.0.0
    • addedInput schema / properties / database / description
      Added value: +"Quote names that aren't all uppercase, exactly as list tools return them."
    • addedInput schema / properties / pipe_name / description
      Added value: +"Quote names that aren't all uppercase, exactly as list tools return them."
    • addedInput schema / properties / schema_name / description
      Added value: +"Quote names that aren't all uppercase, exactly as list tools return them."
  2. Addedv2.0.4

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, covering the safety profile. The description adds no behavioral context beyond restating the object of inspection, so it does not disclose traits 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.

Conciseness4/5

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

A single front-loaded sentence with no filler. It is perhaps overly terse for a tool with several sibling alternatives, but nothing is wasted.

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?

The description plus annotations, full schema coverage, and an output schema make the tool callable. However, it does not explain what a pipe is or how this differs from pipes_get_pipe_status, leaving a knowledgeable agent to infer the distinction.

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 all three parameters are documented in the schema. The description adds no parameter semantics, which is acceptable at the baseline 3 given full schema coverage.

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 verb 'Describe' and resource 'pipe definition and COPY statement' make the operation clear. It implicitly distinguishes from pipes_list_pipes and pipes_get_pipe_status by naming the returned artifacts, though it does not explicitly say when to use it over those siblings.

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?

No when-to-use guidance, prerequisites, or alternative tools are mentioned. The only clue is the word 'Describe', which implies inspection but does not say when to choose this over pipes_get_pipe_status or pipes_list_pipes.

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

Deploy Server

Other Tools