Skip to main content
Glama
hyperspell

hyperspell-mcp

Official
by hyperspell

Search Hyperspell

Search documents and unstructured data to find specific information using AI-powered queries.

Instructions

Search Hyperspell for documents and data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes

Implementation Reference

  • The handler function 'query' that executes the core logic of the 'Search Hyperspell' tool by querying the Hyperspell API and converting results to Document objects.
    def query(query: str) -> list[Document]:
        """Search Hyperspell for documents and data."""
        r = mcp.api.query.search(query=query, collections=mcp.config.collection)
        return Document.from_pydantic(r.documents)
  • The decorator registering the 'query' function as the 'Search Hyperspell' tool with MCP server, specifying the tool name and description.
    @mcp.tool(
        name="Search Hyperspell", description="Search Hyperspell for documents and data."
    )
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 states the tool searches but doesn't disclose behavioral traits such as whether it's read-only or destructive, authentication needs, rate limits, or what the search results look like. This is a significant gap for a search tool with no annotation coverage.

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, efficient sentence with no wasted words. It's appropriately sized and front-loaded, clearly stating the tool's purpose without unnecessary elaboration.

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 complexity of a search tool with no annotations, 0% schema coverage, and no output schema, the description is incomplete. It lacks details on behavior, parameters, and expected results, making it inadequate for the agent to use the tool effectively without additional context.

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 doesn't add any meaning beyond the input schema. It doesn't explain what the 'query' parameter should contain (e.g., keywords, filters, syntax) or how it affects the search, leaving the parameter undocumented in both schema and description.

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

Purpose3/5

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

The description states the tool searches for documents and data in Hyperspell, which is a clear purpose. However, it's somewhat vague about what 'documents and data' specifically means and doesn't differentiate from sibling tools like Get Document or List Collections, which might retrieve similar resources.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives like Get Document or List Collections. The description doesn't mention any context, prerequisites, or exclusions for usage, leaving the agent to infer based on tool names alone.

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/hyperspell/hyperspell-mcp'

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