Skip to main content
Glama
Sign In
mcp-fastapi

mcp-fastapi

by pedroct
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

listar_documentos

List all available FastAPI reference documents to find official documentation for accurate code generation.

Instructions

Lista todos os documentos de referência do FastAPI disponíveis.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "listar_documentos"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. The verb 'list' implies a read-only operation, and 'disponíveis' adds a scoping detail, but the description does not explicitly disclose safety, side effects, or output behavior beyond the inherent meaning of 'list'. It is minimally adequate but not rich.

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 a single, clear sentence without any wasted words. It directly states the action and the object.

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 the zero-parameter complexity and the presence of an output schema, the description is largely complete. It could explicitly mention alternative tools, but that is covered under usage guidelines. The description sufficiently covers the tool's purpose for a simple list operation.

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?

The tool has zero parameters and the schema is empty with 100% coverage. Per the baseline rule for 0-parameter tools, a score of 4 is appropriate; the description does not need to elaborate on parameters.

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 the specific verb 'Lista' (lists) with the resource 'documentos de referência do FastAPI' and the scope 'todos...disponíveis' (all available). This clearly distinguishes it from sibling tools 'buscar_documentos' (search) and 'obter_documento' (get a single 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?

The description implies usage (when you want all available documents), but it does not explicitly state when to use this tool over alternatives. There is no mention of exclusions or when to use 'buscar_documentos' or 'obter_documento' instead.

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

Deploy Server

Other Tools