Skip to main content
Glama
us-all

openmetadata-mcp-server

by us-all

get-container-sample-data

Retrieve sample data from a storage container by its UUID. Inspect contents without full data extraction.

Instructions

Get sample data for a storage container by UUID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesContainer UUID

Implementation Reference

  • Handler function that executes the get-container-sample-data tool. Makes a GET request to /containers/{id}/sampleData.
    export async function getContainerSampleData(params: z.infer<typeof getContainerSampleDataSchema>) {
      return omClient.get(`/containers/${params.id}/sampleData`);
    }
  • Zod schema defining the input parameter (id: Container UUID) for get-container-sample-data.
    export const getContainerSampleDataSchema = z.object({
      id: z.string().describe("Container UUID"),
    });
  • src/index.ts:428-429 (registration)
    Registration of the get-container-sample-data tool with its name, description, schema, and handler.
    tool("get-container-sample-data", "Get sample data for a storage container by UUID", getContainerSampleDataSchema.shape, wrapToolHandler(getContainerSampleData));
    tool("get-container-sample-data-by-name", "Get sample data for a storage container by fully qualified name", getContainerSampleDataByNameSchema.shape, wrapToolHandler(getContainerSampleDataByName));
  • src/index.ts:126-133 (registration)
    Import of getContainerSampleDataSchema and getContainerSampleData from the sample-data module into the main index.ts for registration.
    import {
      getTableSampleDataSchema, getTableSampleData,
      getTableSampleDataByNameSchema, getTableSampleDataByName,
      getTopicSampleDataSchema, getTopicSampleData,
      getTopicSampleDataByNameSchema, getTopicSampleDataByName,
      getContainerSampleDataSchema, getContainerSampleData,
      getContainerSampleDataByNameSchema, getContainerSampleDataByName,
    } from "./tools/sample-data.js";
  • The wrapToolHandler utility that wraps the handler for error handling and redaction.
    export const wrapToolHandler = createWrapToolHandler({
      redactionPatterns: [/OPENMETADATA_TOKEN/i],
      errorExtractors: [
        {
Behavior2/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. It indicates a read operation but does not disclose what happens if the UUID is invalid, if no sample data exists, or any other behavioral nuances beyond the basic function.

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 conveys the essential information without any extraneous words. Every word earns its place.

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

Completeness4/5

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

For a simple tool with one parameter and no output schema, the description provides sufficient context. However, mentioning the return type or format of sample data would enhance completeness. Given the tool's simplicity, the description is largely adequate.

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 already describes the 'id' parameter as 'Container UUID' with 100% coverage. The description reinforces this by saying 'by UUID', but adds minimal extra meaning. Baseline 3 is appropriate given high schema coverage.

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 'Get' and the resource 'sample data for a storage container', and specifies identification by UUID. It effectively distinguishes from the sibling tool 'get-container-sample-data-by-name' which uses name instead.

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

Usage Guidelines3/5

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

Usage context is implied (get sample data by UUID), but no explicit guidance is given on when to use this tool versus the alternative 'get-container-sample-data-by-name' or any other conditions. No exclusions or prerequisites are mentioned.

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/us-all/openmetadata-mcp-server'

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