Skip to main content
Glama
deepset-ai

deepset-mcp

Official
by deepset-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

search_docs

Search Haystack Enterprise Platform documentation for components, pipelines, and AI features, filtering by section to retrieve relevant excerpts with source URLs.

Instructions

Search the Haystack Enterprise Platform documentation.

Use this to find information about Haystack components, pipelines, document stores, embedders, generators, retrievers, and other AI platform features. Returns relevant documentation excerpts with source URLs.

:param query: The search query. Be specific about what you're looking for. Examples: 'How to create a RAG pipeline', 'OpenAI embedder configuration', 'document store filters'. :param section: Optional documentation section id from list_doc_sections (for example, how-to-guides or api). Limits results to that section. :returns: Relevant documentation excerpts with source URLs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
sectionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.27
    • addedInput schema / properties / section
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "title": "Section"
+}
  2. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses the return shape ('excerpts with source URLs') and that section narrows results, but says nothing about ranking, result count limits, pagination, or empty-result behavior for a search tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

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

Front-loaded with the one-line purpose, then scope, then parameters. Sphinx-style ':param:' markup is slightly verbose and the ':returns:' line restates the 'source URLs' already stated in the opening paragraph, a minor redundancy but not wasteful overall.

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?

No output schema and no annotations, so the description must stand alone; it covers purpose, both parameters, and the return contents, which is nearly enough for a two-parameter read tool. It stops short on result-volume and pagination behavior, the main remaining gap.

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

Parameters5/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, and it does: 'query' is explained with three concrete example queries, and the optional 'section' is defined as a section id sourced from list_doc_sections with two examples ('how-to-guides', 'api'). This resolves the meaning and provenance of both parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Search the Haystack Enterprise Platform documentation') and enumerates the topical scope (components, pipelines, document stores, embedders, generators, retrievers). It is implicitly distinct from sibling search tools like search_pipeline and search_templates, but never names them, leaving the agent to infer the boundary.

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?

Explicitly frames when to use it ('Use this to find information about Haystack components, pipelines...') and points to list_doc_sections as the source for valid section ids, which is a genuine routing hint. No when-not guidance or exclusion against the other search_* siblings.

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