Skip to main content
Glama
us-all

openmetadata-mcp-server

by us-all

get-container-sample-data-by-name

Retrieve sample data from a storage container by providing its fully qualified name.

Instructions

Get sample data for a storage container by fully qualified name

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fqnYesFully qualified container name

Implementation Reference

  • src/index.ts:429-429 (registration)
    Registration of the 'get-container-sample-data-by-name' tool in the MCP server with its description and schema.
    tool("get-container-sample-data-by-name", "Get sample data for a storage container by fully qualified name", getContainerSampleDataByNameSchema.shape, wrapToolHandler(getContainerSampleDataByName));
  • Handler function that resolves the container FQN to a UUID, then fetches sample data from the containers API endpoint.
    export async function getContainerSampleDataByName(params: z.infer<typeof getContainerSampleDataByNameSchema>) {
      const entity = await omClient.get<{ id: string }>(`/containers/name/${encodeURIComponent(params.fqn)}`, { fields: "id" });
      return omClient.get(`/containers/${entity.id}/sampleData`);
  • Zod schema for the input: 'fqn' (fully qualified container name as a string).
    export const getContainerSampleDataByNameSchema = z.object({
      fqn: z.string().describe("Fully qualified container name"),
    });
  • Import of the schema and handler from './tools/sample-data.js'.
    import { wrapToolHandler } from "./tools/utils.js";
Behavior2/5

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

No annotations are provided, and the description does not disclose any behavioral aspects such as permissions required, error conditions, or the structure of the returned sample data. The description is minimal and does not compensate for the lack of annotations.

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 extremely concise, consisting of a single sentence with no redundant words. It is front-loaded and to the point.

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 absence of an output schema and annotations, the description should at least hint at the nature of the sample data or any restrictions. It does not, leaving the agent without information on what to expect. For a simple retrieval tool this might be forgivable, but completeness is lacking.

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 input schema already describes the 'fqn' parameter as 'Fully qualified container name'. The tool description merely reiterates this without adding further details about valid formats, examples, or constraints. Since schema coverage is 100%, additional description is not critical but also not provided.

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 that the tool retrieves sample data for a storage container using its fully qualified name. The verb 'Get' and resource 'sample data' are specific, and the mention of 'by fully qualified name' distinguishes it from siblings like 'get-container-sample-data' (which may use other identifiers).

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 such as 'get-container-sample-data', 'get-table-sample-data', etc. It fails to explain typical use cases or exclusions.

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