Skip to main content
Glama

get_flow_model_by_parent

Retrieve a flow page block by parent ID and sub-key to navigate the block tree.

Instructions

Get a flowPage block/model by its parent ID and subKey. Useful for navigating the flowPage block tree.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
parentIdYesParent flow model UID
subKeyNoSub-key within the parent (e.g. 'items')
includeAsyncNodeNoWhether to include async node data (default false)

Implementation Reference

  • src/index.ts:212-228 (registration)
    The tool 'get_flow_model_by_parent' is registered using server.registerTool with input schema for parentId (required), subKey (optional), and includeAsyncNode (optional). The handler constructs a query string and calls the NocoBase API endpoint /api/flowModels:findOne.
    // 16. get_flow_model_by_parent
    server.registerTool(
      "get_flow_model_by_parent",
      {
        description: "Get a flowPage block/model by its parent ID and subKey. Useful for navigating the flowPage block tree.",
        inputSchema: {
          parentId: z.string().describe("Parent flow model UID"),
          subKey: z.string().optional().describe("Sub-key within the parent (e.g. 'items')"),
          includeAsyncNode: z.boolean().optional().describe("Whether to include async node data (default false)"),
        },
      },
      async ({ parentId, subKey, includeAsyncNode = false }) => {
        const qs = new URLSearchParams({ parentId, includeAsyncNode: String(includeAsyncNode) });
        if (subKey) qs.set("subKey", subKey);
        return ok(await nocoFetch(`/api/flowModels:findOne?${qs}`));
      }
    );
  • Schema/input validation for get_flow_model_by_parent: parentId is a required string, subKey is optional string, includeAsyncNode is optional boolean.
    description: "Get a flowPage block/model by its parent ID and subKey. Useful for navigating the flowPage block tree.",
    inputSchema: {
      parentId: z.string().describe("Parent flow model UID"),
      subKey: z.string().optional().describe("Sub-key within the parent (e.g. 'items')"),
      includeAsyncNode: z.boolean().optional().describe("Whether to include async node data (default false)"),
    },
  • Handler function for get_flow_model_by_parent: builds query parameters (parentId, includeAsyncNode, optionally subKey) and fetches from the flowModels:findOne API endpoint.
      async ({ parentId, subKey, includeAsyncNode = false }) => {
        const qs = new URLSearchParams({ parentId, includeAsyncNode: String(includeAsyncNode) });
        if (subKey) qs.set("subKey", subKey);
        return ok(await nocoFetch(`/api/flowModels:findOne?${qs}`));
      }
    );
  • The 'ok' helper utility wraps data into the MCP content response format used by the handler.
    const ok = (data: unknown) => ({
      content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }],
    });
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 behavioral traits such as idempotency, read-only nature, or side effects. It only describes the operation's purpose without additional behavioral context.

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?

Two sentences efficiently convey the tool's purpose and use case without any redundant words. The information is front-loaded and every sentence adds value.

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?

For a simple getter tool with no output schema, the description covers the basic usage scenario. However, it lacks details about return values, error conditions, or the structure of a flowPage block model, which could be helpful for completeness.

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% with descriptions for all three parameters. The description reinforces the key parameters (parentId and subKey) but adds no new semantic meaning beyond what the schema already provides.

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 'Get a flowPage block/model by its parent ID and subKey', using a specific verb and resource. It distinguishes itself from siblings like 'get_flow_model' by specifying the lookup method, though it could explicitly differentiate from other getters.

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?

The description says 'Useful for navigating the flowPage block tree', implying when to use it, but does not provide explicit when-not-to-use guidance or mention alternatives among siblings.

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/puguhsudarma/nocobase-mcp-server'

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