`search`

Pack: hal-fr · Endpoint: https://gateway.pipeworx.io/hal-fr/mcp

Solr-style search across HAL.

Parameters

Name	Type	Required	Description
`query`	string	yes	Free-text or Solr query (e.g. “title_t:transformer”).
`fl`	string	no	Comma-sep fields to return.
`fq`	string	no	Solr filter query.
`rows`	number	no	1-10000 (default 25).
`start`	number	no	0-based offset.
`sort`	string	no	e.g. “submittedDate_tdate desc”

Example call

Arguments

{
  "query": "title_t:transformer"
}

curl

curl -X POST https://gateway.pipeworx.io/hal-fr/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"search","arguments":{"query":"title_t:transformer"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('search', {
  "query": "title_t:transformer"
});

More examples

{
  "query": "authId_i:12345",
  "fl": "docid,title_s,submittedDate_tdate",
  "rows": 100,
  "sort": "submittedDate_tdate desc"
}

Response shape

Field	Type	Description
`responseHeader`	object	Response metadata
`response`	object	Search results

Full JSON Schema

{
  "type": "object",
  "description": "Solr search response from HAL API",
  "properties": {
    "responseHeader": {
      "type": "object",
      "description": "Response metadata",
      "properties": {
        "status": {
          "type": "integer",
          "description": "HTTP status code"
        },
        "QTime": {
          "type": "integer",
          "description": "Query execution time in ms"
        },
        "params": {
          "type": "object",
          "description": "Query parameters echoed back"
        }
      }
    },
    "response": {
      "type": "object",
      "description": "Search results",
      "properties": {
        "numFound": {
          "type": "integer",
          "description": "Total number of matching documents"
        },
        "start": {
          "type": "integer",
          "description": "Starting offset of results"
        },
        "docs": {
          "type": "array",
          "description": "Array of matching documents",
          "items": {
            "type": "object",
            "description": "Document object with requested fields"
          }
        }
      }
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "hal-fr": {
      "url": "https://gateway.pipeworx.io/hal-fr/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

search