Skip to main content
Glama

pydantic_search

Retrieve relevant documentation from Pydantic and Pydantic-AI using BM25 search with optional filters for site, heading, and keywords.

Instructions

Search local Pydantic + Pydantic-AI docs with filters.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kNo
siteNo
queryYes
headingNo
keywordsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultsYes
Behavior2/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. It only states 'Search ... docs with filters' without disclosing whether it is read-only, required authentication, rate limits, or any side effects. Basic behavioral context is missing.

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 extremely concise—one sentence with no fluff. It is front-loaded with the key verb and resource, making it efficient for agents to parse.

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?

Given the presence of an output schema (true), return values are covered. However, with 5 parameters and no parameter descriptions, and minimal usage guidance, the description is incomplete for a search tool with multiple filters. The complexity requires more detail than provided.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, and the description does not explain any of the 5 parameters (k, site, heading, keywords, query) beyond the generic term 'filters'. The description adds very little meaning to the parameter names and defaults.

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 verb 'Search', the resource 'local Pydantic + Pydantic-AI docs', and mentions filters, which distinguishes it from sibling tools like pydantic_get, pydantic_section, etc.

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 for filtered searches but provides no explicit guidance on when to use this tool versus alternatives like pydantic_api or pydantic_get. No exclusions or prerequisites are mentioned.

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/Magic-Man-us/mcp_pydantic_docs'

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