Skip to main content
Glama

get_document

Read-onlyIdempotent

Retrieve a document by its UUID to access its full markdown content.

Instructions

Get a document by ID, including its full markdown content

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesDocument UUID

Implementation Reference

  • The handler function for the 'get_document' tool. It takes a document UUID, makes a GET request to /v1/documents/{id}, and returns the full document including markdown content.
      async ({ id }) => {
        try {
          const result = await client.request(
            "GET",
            `/v1/documents/${encodeURIComponent(id)}`,
          );
          return jsonResult(result);
        } catch (err) {
          return errorResult(err);
        }
      },
    );
  • Input schema for get_document: requires a single 'id' field (string) describing the Document UUID.
    {
      id: z.string().describe("Document UUID"),
    },
  • src/tools.ts:176-200 (registration)
    Registration of the 'get_document' tool via server.tool() with metadata (title, readOnlyHint, etc.) and the handler function.
    server.tool(
      "get_document",
      "Get a document by ID, including its full markdown content",
      {
        id: z.string().describe("Document UUID"),
      },
      {
        title: "Get Document",
        readOnlyHint: true,
        destructiveHint: false,
        idempotentHint: true,
        openWorldHint: true,
      },
      async ({ id }) => {
        try {
          const result = await client.request(
            "GET",
            `/v1/documents/${encodeURIComponent(id)}`,
          );
          return jsonResult(result);
        } catch (err) {
          return errorResult(err);
        }
      },
    );
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, etc. Description adds that the response includes full markdown content, but no further behavioral details. Adequate given annotation coverage.

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?

One concise sentence, front-loaded with key information. No wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only tool with one parameter and no output schema, the description is sufficient: it states the operation, parameter, and return content.

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 has 100% coverage with a clear description for the single 'id' parameter. Description does not add extra semantics beyond stating retrieval by ID.

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?

Description clearly states the action (Get), resource (document), method (by ID), and content included (full markdown). Distinguishes from sibling tools like list_documents and update_document.

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?

No explicit guidance on when to use vs alternatives like list_documents for searching or create_document for new ones. However, for a simple retrieval tool, usage is implicitly clear.

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

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