Skip to main content
Glama
aserper

RTFD (Read The F*****g Docs)

by aserper

fetch_docker_image_docs

Retrieve Docker image documentation from DockerHub to understand container usage, environment variables, volume mounts, and configuration examples.

Instructions

        Fetch actual Docker image documentation and README from DockerHub.

        USE THIS WHEN: You need usage instructions, environment variables, volume mounts, or examples.

        BEST FOR: Understanding how to use a Docker image and configure it properly.
        Better than using curl or WebFetch because it:
        - Extracts README content from DockerHub
        - Includes image description and key details
        - Formats content in readable Markdown
        - Prioritizes important sections (Usage, Environment Variables, Examples)

        Typical content includes:
        - How to run the container
        - Available environment variables
        - Volume mount points
        - Port configurations
        - Usage examples and docker-compose snippets

        Args:
            image: Docker image name (e.g., "nginx", "postgres", "redis")
            max_bytes: Maximum content size, default 20KB (increase for detailed docs)

        Returns:
            JSON with README content, size, and source info

        Example: fetch_docker_image_docs("nginx") → Returns README with usage instructions
        

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
imageYes
max_bytesNo
Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behaviors: it extracts README content from DockerHub, formats it in readable Markdown, prioritizes important sections, and includes details about content size handling via 'max_bytes'. However, it doesn't mention potential limitations like rate limits, authentication needs, or error conditions, which keeps it from a perfect score.

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?

The description is well-structured with clear sections (purpose, usage guidelines, benefits, typical content, args, returns, example) and every sentence adds value. It's front-loaded with the core purpose and usage context, avoiding redundancy. The length is appropriate for the tool's complexity.

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

Completeness4/5

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

Given no annotations and no output schema, the description does a good job covering purpose, usage, parameters, and expected return content. It mentions the return format ('JSON with README content, size, and source info') and provides an example. However, it lacks details on error handling or edge cases (e.g., invalid image names), which would enhance completeness for a tool with 2 parameters and no structured output schema.

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?

Schema description coverage is 0%, so the description must compensate. It adds meaningful context for both parameters: 'image' is explained with examples ('nginx', 'postgres', 'redis') and 'max_bytes' is described with its default (20KB) and purpose ('increase for detailed docs'). This goes beyond the bare schema, though it doesn't detail format constraints for 'image' (e.g., repository/tag syntax).

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?

The description clearly states the specific action ('Fetch actual Docker image documentation and README from DockerHub') and distinguishes it from siblings like 'docker_image_metadata' (which likely provides metadata rather than docs) and 'fetch_dockerfile' (which fetches Dockerfile instead of README). It explicitly names the resource (Docker image docs/README) and source (DockerHub).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description includes explicit 'USE THIS WHEN' and 'BEST FOR' sections that specify when to use this tool (for usage instructions, environment variables, etc.) and contrasts it with alternatives like 'curl or WebFetch', explaining why this tool is better. It provides clear context about its specialized purpose for Docker image documentation.

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/aserper/RTFD'

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