search_index

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

Search WITHIN a documentation set for a specific entry (method/function/API/property) by substring — THIS is the content lookup. E.g. slug=“javascript”, query=“Array.map”; slug=“python”, query=“os.path”. Get valid slugs from docs/search_docs.

Parameters

NameTypeRequiredDescription
slugstringyesThe documentation set, e.g. “javascript”, “python”, “react”.
querystringyesThe entry/term to find, e.g. “Array.map”, “fetch”.
limitnumberno

Example call

Arguments

{
  "slug": "javascript",
  "query": "array methods"
}

curl

curl -X POST https://gateway.pipeworx.io/devdocs-io/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"search_index","arguments":{"slug":"javascript","query":"array methods"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('search_index', {
  "slug": "javascript",
  "query": "array methods"
});

More examples

{
  "slug": "react",
  "query": "useState",
  "limit": 5
}

Response shape

Always returns: count, entries

FieldTypeDescription
countnumberNumber of matching entries returned
entriesarrayFiltered entries matching the query
Full JSON Schema
{
  "type": "object",
  "properties": {
    "count": {
      "type": "number",
      "description": "Number of matching entries returned"
    },
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Entry name"
          },
          "path": {
            "type": "string",
            "description": "Entry path identifier"
          },
          "type": {
            "type": "string",
            "description": "Entry type category"
          }
        },
        "required": [
          "name",
          "path",
          "type"
        ]
      },
      "description": "Filtered entries matching the query"
    }
  },
  "required": [
    "count",
    "entries"
  ]
}

Connect

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

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

See Getting Started for client-specific install steps.

Regenerated from source · build July 6, 2026