search_entities
Pack: permid · Endpoint: https://gateway.pipeworx.io/permid/mcp
Search PermID for organizations, people, instruments, or quotes by name. Returns PermID, primary type, name, and a brief context. Use get_entity with the PermID for the full linked-data record.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
query | string | yes | Free-text search term |
entity_type | string | no | Restrict by type |
limit | number | no | 1-100 (default 20) |
Example call
Arguments
{
"query": "Apple Inc"
}curl
curl -X POST https://gateway.pipeworx.io/permid/mcp \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"search_entities","arguments":{"query":"Apple Inc"}}}'TypeScript (@pipeworx/sdk)
import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();
const result = await pipeworx.call('search_entities', {
"query": "Apple Inc"
});More examples
{
"query": "Tesla",
"entity_type": "organization",
"limit": 10
}Response shape
Always returns: organizations, instruments, quotes, people
| Field | Type | Description |
|---|---|---|
organizations | array | List of matching organizations |
instruments | array | List of matching instruments |
quotes | array | List of matching quotes |
people | array | List of matching people |
Full JSON Schema
{
"type": "object",
"properties": {
"organizations": {
"type": "array",
"description": "List of matching organizations",
"items": {
"type": "object",
"properties": {
"permid_url": {
"type": [
"string",
"null"
],
"description": "Full PermID URL"
},
"permid": {
"type": [
"string",
"null"
],
"description": "PermID numeric identifier"
},
"type": {
"type": [
"string",
"null"
],
"description": "Entity type (@type from API)"
},
"name": {
"type": [
"string",
"null"
],
"description": "Organization name"
},
"primary_ric": {
"type": [
"string",
"null"
],
"description": "Primary RIC identifier"
},
"primary_ticker": {
"type": [
"string",
"null"
],
"description": "Primary ticker symbol"
},
"country": {
"type": [
"string",
"null"
],
"description": "Country of organization"
},
"org_status": {
"type": [
"string",
"null"
],
"description": "Organization status code"
},
"homepage": {
"type": [
"string",
"null"
],
"description": "Organization homepage URL"
}
}
}
},
"instruments": {
"type": "array",
"description": "List of matching instruments",
"items": {
"type": "object",
"properties": {
"permid_url": {
"type": [
"string",
"null"
],
"description": "Full PermID URL"
},
"permid": {
"type": [
"string",
"null"
],
"description": "PermID numeric identifier"
},
"type": {
"type": [
"string",
"null"
],
"description": "Entity type (@type from API)"
},
"name": {
"type": [
"string",
"null"
],
"description": "Instrument name"
},
"primary_ric": {
"type": [
"string",
"null"
],
"description": "Primary RIC identifier"
},
"primary_ticker": {
"type": [
"string",
"null"
],
"description": "Primary ticker symbol"
},
"country": {
"type": [
"string",
"null"
],
"description": "Country of instrument"
},
"org_status": {
"type": [
"string",
"null"
],
"description": "Organization status code"
},
"homepage": {
"type": [
"string",
"null"
],
"description": "Homepage URL"
}
}
}
},
"quotes": {
"type": "array",
"description": "List of matching quotes",
"items": {
"type": "object",
"properties": {
"permid_url": {
"type": [
"string",
"null"
],
"description": "Full PermID URL"
},
"permid": {
"type": [
"string",
"null"
],
"description": "PermID numeric identifier"
},
"type": {
"type": [
"string",
"null"
],
"description": "Entity type (@type from API)"
},
"name": {
"type": [
"string",
"null"
],
"description": "Quote name"
},
"primary_ric": {
"type": [
"string",
"null"
],
"description": "Primary RIC identifier"
},
"primary_ticker": {
"type": [
"string",
"null"
],
"description": "Primary ticker symbol"
},
"country": {
"type": [
"string",
"null"
],
"description": "Country of quote"
},
"org_status": {
"type": [
"string",
"null"
],
"description": "Organization status code"
},
"homepage": {
"type": [
"string",
"null"
],
"description": "Homepage URL"
}
}
}
},
"people": {
"type": "array",
"description": "List of matching people",
"items": {
"type": "object",
"properties": {
"permid_url": {
"type": [
"string",
"null"
],
"description": "Full PermID URL"
},
"permid": {
"type": [
"string",
"null"
],
"description": "PermID numeric identifier"
},
"type": {
"type": [
"string",
"null"
],
"description": "Entity type (@type from API)"
},
"name": {
"type": [
"string",
"null"
],
"description": "Person name"
},
"primary_ric": {
"type": [
"string",
"null"
],
"description": "Primary RIC identifier"
},
"primary_ticker": {
"type": [
"string",
"null"
],
"description": "Primary ticker symbol"
},
"country": {
"type": [
"string",
"null"
],
"description": "Country of person"
},
"org_status": {
"type": [
"string",
"null"
],
"description": "Organization status code"
},
"homepage": {
"type": [
"string",
"null"
],
"description": "Homepage URL"
}
}
}
}
},
"required": [
"organizations",
"instruments",
"quotes",
"people"
]
}Connect
Add this to your MCP client config, or use one-click install buttons:
{
"mcpServers": {
"permid": {
"url": "https://gateway.pipeworx.io/permid/mcp"
}
}
}See Getting Started for client-specific install steps.