`get`

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

Single document by HAL id.

Parameters

Name	Type	Required	Description
`hal_id`	string	yes

Example call

Arguments

{
  "hal_id": "hal-01234567"
}

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":"get","arguments":{"hal_id":"hal-01234567"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('get', {
  "hal_id": "hal-01234567"
});

Response shape

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

Full JSON Schema

{
  "type": "object",
  "description": "Single document lookup 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 (typically 0 or 1)",
          "items": {
            "type": "object",
            "description": "Document object"
          }
        }
      }
    }
  }
}

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.

get