Skip to main content
Glama

get_page

Retrieves the complete nested UI schema tree for a given node UID, including all descendant properties.

Instructions

Get the full nested UI schema tree for a node by UID (uses :getProperties to include all descendants)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidYesUI schema UID

Implementation Reference

  • src/index.ts:67-74 (registration)
    Registration of the 'get_page' tool on the MCP server with its schema (uid input string) and handler function.
    server.registerTool(
      "get_page",
      {
        description: "Get the full nested UI schema tree for a node by UID (uses :getProperties to include all descendants)",
        inputSchema: { uid: z.string().describe("UI schema UID") },
      },
      async ({ uid }) => ok(await nocoFetch(`/api/uiSchemas:getProperties/${uid}`))
    );
  • Handler function for 'get_page': calls the NocoBase API endpoint /api/uiSchemas:getProperties/{uid} to retrieve the full nested UI schema tree.
    async ({ uid }) => ok(await nocoFetch(`/api/uiSchemas:getProperties/${uid}`))
  • Input schema for 'get_page': expects a single required string parameter 'uid' representing the UI schema UID.
    inputSchema: { uid: z.string().describe("UI schema UID") },
  • The nocoFetch helper function and ok response wrapper used by the get_page handler.
    async function nocoFetch(path: string, options: RequestInit = {}): Promise<unknown> {
      const url = `${NOCOBASE_URL}${path}`;
      const res = await fetch(url, {
        ...options,
        headers: { ...reqHeaders, ...(options.headers as Record<string, string> | undefined) },
      });
      const text = await res.text();
      if (!res.ok) throw new Error(`HTTP ${res.status} ${res.statusText}: ${text}`);
      try { return JSON.parse(text); } catch { return text; }
    }
Behavior3/5

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

Discloses inclusion of all descendants and :getProperties method, but lacks info on error handling, permissions, or idempotency. Annotations absent so burden on description.

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?

Single sentence with purpose front-loaded and method detail in parentheses. No filler.

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?

No output schema; description gives high-level idea of return type but lacks specifics on structure or fields. Adequate for simple tool but incomplete for agent to fully anticipate response.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Description adds context to the 'uid' parameter by specifying it's a node UID in UI schema tree, beyond the schema's brief description. Single param with 100% 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?

Clear verb 'Get' and specific resource 'full nested UI schema tree' with method hint. Distinguishes from siblings like get_flow_model or get_parent_schema.

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?

Implies use when full tree is needed but no explicit guidance on when not to use or alternatives like get_parent_schema for single node.

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