search

Search within a specific collection using keywords, filter, sort, group, or facet results to refine queries. Retrieve documents based on defined criteria and paginate results for efficient data access in Typesense databases.

Instructions

Performs a keyword search on a specific collection.

Args:
    ctx (Context): The MCP context.
    collection_name (str): The name of the collection to search within.
    query (str): The search query string. Use '*' for all documents.
    query_by (str): Comma-separated list of fields to search in.
    filter_by (str | None): Filter conditions (e.g., 'price:>100 && category:Electronics'). Defaults to None.
    sort_by (str | None): Sorting criteria (e.g., 'price:asc, rating:desc'). Defaults to None.
    group_by (str | None): Field to group results by. Defaults to None.
    facet_by (str | None): Fields to facet on. Defaults to None.
    per_page (int): Number of results per page. Defaults to 20.
    page (int): Page number to retrieve. Defaults to 1.


Returns:
    dict | str: The search results dictionary from Typesense or an error message string.

Input Schema

Name	Required	Description	Default
`collection_name`	Yes
`facet_by`	No
`filter_by`	No
`group_by`	No
`page`	No
`per_page`	No
`query`	Yes
`query_by`	Yes
`sort_by`	No

Input Schema (JSON Schema)

{
  "properties": {
    "collection_name": {
      "title": "Collection Name",
      "type": "string"
    },
    "facet_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Facet By"
    },
    "filter_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Filter By"
    },
    "group_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Group By"
    },
    "page": {
      "default": 1,
      "title": "Page",
      "type": "integer"
    },
    "per_page": {
      "default": 20,
      "title": "Per Page",
      "type": "integer"
    },
    "query": {
      "title": "Query",
      "type": "string"
    },
    "query_by": {
      "title": "Query By",
      "type": "string"
    },
    "sort_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Sort By"
    }
  },
  "required": [
    "collection_name",
    "query",
    "query_by"
  ],
  "title": "searchArguments",
  "type": "object"
}

Typesense MCP Server

search

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Typesense MCP Server

Related Tools