Skip to main content
Glama

get_custom_record

Read-onlyIdempotent

Retrieve a specific custom record by providing the parent resource ID and the record ID.

Instructions

Get a custom record

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
object_slugYesID of the parent resource
idYesID of the custom record to retrieve

Implementation Reference

  • Registration of the 'get_custom_record' tool with input schema and handler
    server.registerTool(
      "get_custom_record",
      {
        description: "Get a custom record",
        annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
        inputSchema: {
          object_slug: z.number().int().positive().describe("ID of the parent resource"),
          id: z.number().int().positive().describe("ID of the custom record to retrieve"),
        },
      },
      async ({ object_slug, id }) => {
        try {
          const record = await apiGet<EduframeRecord>(`/custom/objects/${object_slug}/records/${record_id}`);
          void logResponse("get_custom_record", { object_slug, id }, record);
          return formatShow(record, "custom record");
        } catch (error) {
          return formatError(error);
        }
      },
    );
  • Handler function for get_custom_record - fetches a custom record by object_slug and id via API call
    async ({ object_slug, id }) => {
      try {
        const record = await apiGet<EduframeRecord>(`/custom/objects/${object_slug}/records/${record_id}`);
        void logResponse("get_custom_record", { object_slug, id }, record);
        return formatShow(record, "custom record");
      } catch (error) {
        return formatError(error);
      }
    },
  • Input schema for get_custom_record: object_slug (int, positive, required) and id (int, positive, required)
    {
      description: "Get a custom record",
      annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },
      inputSchema: {
        object_slug: z.number().int().positive().describe("ID of the parent resource"),
        id: z.number().int().positive().describe("ID of the custom record to retrieve"),
      },
Behavior3/5

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

Annotations (readOnlyHint=true, destructiveHint=false, idempotentHint=true) already indicate safe read operations. The description adds no further behavioral context, such as response structure or potential errors, but it does not contradict the annotations.

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

Conciseness4/5

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

The description is extremely concise with no extraneous text. However, it could be expanded slightly to include key details without losing 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 2 required parameters and no output schema, the description is insufficient. It lacks details about what is returned, error handling, and the relationship between object_slug and the custom record.

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?

Input schema provides descriptions for both parameters (object_slug and id) with 100% coverage. The description adds no additional meaning beyond the schema, which already clarifies the parameter roles.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Get a custom record' states a verb and resource, but lacks specificity compared to siblings like 'get_custom_records' (plural). It doesn't clarify that it retrieves a single record by unique identifiers, which would differentiate it from the list endpoint.

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?

No guidance is provided on when to use this tool versus alternatives such as 'get_custom_records' or other get tools. There is no mention of prerequisites or context for invoking it.

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/martijnpieters/eduframe-mcp'

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