Skip to main content
Glama
us-all

openmetadata-mcp-server

by us-all

list-data-products

Retrieve paginated data products with optional filters like domain, fields, and include deleted items. Control pagination using cursor-based before/after parameters.

Instructions

List data products with pagination

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldsNoComma-separated fields to include
limitNoNumber of results per page
beforeNoCursor for backward pagination
afterNoCursor for forward pagination
domainNoFilter by domain FQN
includeNoInclude deleted entitiesnon-deleted

Implementation Reference

  • The handler function that executes the list-data-products tool logic. Calls omClient.get('/dataProducts', params) with pagination/filtering parameters.
    export async function listDataProducts(params: z.infer<typeof listDataProductsSchema>) {
      return omClient.get("/dataProducts", params);
    }
  • Zod schema defining input parameters for list-data-products: fields, limit (default 10), before/after cursors for pagination, domain filter, and include (non-deleted/deleted/all).
    export const listDataProductsSchema = z.object({
      fields: z.string().optional().describe("Comma-separated fields to include"),
      limit: z.coerce.number().optional().default(10).describe("Number of results per page"),
      before: z.string().optional().describe("Cursor for backward pagination"),
      after: z.string().optional().describe("Cursor for forward pagination"),
      domain: z.string().optional().describe("Filter by domain FQN"),
      include: z.enum(["non-deleted", "deleted", "all"]).optional().default("non-deleted").describe("Include deleted entities"),
    });
  • src/index.ts:345-345 (registration)
    Tool registration using the tool() MCP helper. Registers 'list-data-products' with description, schema shape, and handler wrapped with wrapToolHandler.
    tool("list-data-products", "List data products with pagination", listDataProductsSchema.shape, wrapToolHandler(listDataProducts));
  • The omClient from '../client.js' is used as the HTTP client helper to make the GET /dataProducts API call.
    import { omClient } from "../client.js";
Behavior1/5

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

No annotations are provided, so the description must disclose behavioral traits. It only states 'with pagination' but does not explain pagination behavior, authentication requirements, rate limits, or what happens with empty results. The schema hints at pagination but not exhaustively.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

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

At only four words, the description is too sparse to be useful. While concise, it lacks necessary context about the tool's operation, sacrificing completeness for brevity.

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?

For a tool with 6 parameters and no output schema, the description should explain how pagination cursors work, what the include and domain filters do, and the format of the response. It provides none of this, leaving agents to infer from parameter descriptions alone.

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 coverage is 100%, so all parameters have descriptions. The description adds no extra meaning beyond stating pagination, which is already evident from parameters like limit, before, after. Baseline 3 is appropriate as the schema already does the heavy lifting.

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 description clearly states 'List data products' which identifies the resource and action. However, it lacks specificity about scope (e.g., all data products? owned by the user?) and doesn't distinguish itself from other list-* or get-* tools beyond the resource name.

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 like get-data-product (for a single item) or search-metadata. No conditions, prerequisites, or exclusions 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