Skip to main content
Glama

Inspect Docker project

inspect_project
Read-onlyIdempotent

Inspect a project directory to list Docker artifacts: Dockerfiles, Compose files, .env files, source directories, dependency files, and Compose service names. Secret values are never returned.

Instructions

Start here. Given a project directory, report which Docker artefacts it contains: Dockerfile(s), a Compose file, .env files, source directories, dependency files and the names of the Compose services. Secret values are never returned.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
notesNo
env_fileNo
servicesNo
env_filesNo
dockerfileNo
source_dirsNo
compose_fileNo
compose_pathNo
config_filesNo
project_nameYes
project_pathYes
dependency_filesNo
dockerfile_pathsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, lowering the bar. The description adds a meaningful behavioral guarantee: 'Secret values are never returned,' and clearly scopes what artefacts are reported. Nothing contradicts 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.

Conciseness5/5

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

The description is compact, front-loaded with 'Start here,' then provides a precise artefact list and a security caveat. Every sentence earns its place; there is no filler or redundant restatement of the title.

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 single-parameter, read-only inspection tool with an output schema and safety annotations, the description covers the key facts: what the tool reports, what path it expects, and the secrets-handling behavior. Nothing critical is missing for an agent to select and invoke it correctly.

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 does so by defining the path as a 'project directory,' which is more informative than the bare schema title 'Path.' It does not specify path format or accessibility, but for a single obvious parameter this is adequate.

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 uses a specific verb-resource pair and clearly defines the tool's scope: 'report which Docker artefacts it contains.' Enumerating Dockerfile(s), Compose file, .env files, source directories, dependency files, and Compose service names distinguishes it from siblings like inspect_dockerfile and inspect_compose, which presumably inspect individual artefacts in detail.

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

Usage Guidelines4/5

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

The opening phrase 'Start here' explicitly positions this tool as the entry point, and the artefact list maps naturally to sibling inspection tools, implying this is the discovery step before deeper inspection. However, it does not explicitly name alternatives or state when not to use this tool, so it stops short of a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.