Skip to main content
Glama

yade_query_api

Search YADE Python API documentation by keywords to find classes and functions when exact names are unknown. Returns ranked matches with descriptions.

Instructions

Search YADE API documentation by keywords (like grep).

Returns matching class/function names with descriptions ranked by relevance. Use yade_browse_api for full documentation of a specific class.

When to use:

  • You have keywords but don't know the exact class name

  • Examples: "friction material", "gravity engine", "contact force", "triaxial stress", "sphere create", "hertz mindlin"

Related tools:

  • yade_browse_api: Get full documentation for a known class path

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesSearch keywords for YADE Python API. Examples: 'sphere body', 'triaxial compression', 'contact force'. Case-insensitive.
limitNoMaximum number of results (1-20).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

No annotations provided, so description carries full burden. Discloses return format ('matching class/function names with descriptions'), ranking behavior ('ranked by relevance'), and matching semantics ('like grep'). Does not mention error handling for empty results.

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?

Excellent structure with front-loaded purpose statement, followed by return value description, usage guidelines with bullet points, and related tools section. No redundant text; every sentence provides actionable context.

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?

Given 100% schema coverage and existence of output schema, description appropriately focuses on usage context and sibling differentiation rather than parameter mechanics. Covers purpose, returns, usage scenarios, and alternatives comprehensively for a search tool of this complexity.

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 coverage is 100%, establishing baseline 3. Description adds value with 'like grep' analogy clarifying substring matching behavior for the 'query' parameter, and provides concrete domain examples ('friction material', 'hertz mindlin') supplementing schema examples.

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?

Specific verb 'Search' with resource 'YADE API documentation' and mechanism 'like grep'. Clearly distinguishes from sibling yade_browse_api by contrasting keyword search with full documentation retrieval.

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?

Explicit 'When to use' section with concrete scenario ('You have keywords but don't know the exact class name') and domain-specific examples. Directly names alternative tool yade_browse_api for the complementary use case.

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/yusong652/yade-mcp'

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