get_family
Pack: epo-ops · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)
No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/get_family for the schema, then POST the same URL with its arguments for the data.
INPADOC family — every related patent publication worldwide covering the same underlying invention, which is how you find the Chinese, Japanese, US, European and PCT/WO members of one filing. Returns a member count and the countries covered first, then one row per family member: publication number (with kind and date), application number, and priority claims. A PCT international application is a normal member here — give its “WO” publication number, or (before it has published) a WIPO application number like “PCT/US2024/012345”. This does NOT include the International Search Report or Written Opinion of a PCT application — EPO OPS does not carry that document at all; for it, go to WIPO PATENTSCOPE (patentscope.wipo.int). Give the publication number as printed on the document; a trailing kind code is handled for you.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
number | string | yes | |
raw | boolean | no | Include the raw OPS XML-as-JSON family payload alongside the normalised member list. Off by default — the normalised list has everything most callers need. |
Example call
Arguments
{
"number": "EP1234567"
}curl
curl -X POST https://gateway.pipeworx.io/epo-ops/mcp \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_family","arguments":{"number":"EP1234567"}}}'TypeScript (@pipeworx/sdk)
import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();
const result = await pipeworx.call('get_family', {
"number": "EP1234567"
});More examples
{
"number": "WO2012135025"
}Response shape
| Field | Type | Description |
|---|---|---|
found | boolean | |
requested_number | string | |
resolved_number | string | |
family | object |
Full JSON Schema
{
"type": "object",
"properties": {
"found": {
"type": "boolean"
},
"requested_number": {
"type": "string"
},
"resolved_number": {
"type": "string"
},
"family": {
"type": "object",
"properties": {
"ops:world-patent-data": {
"type": "object",
"properties": {
"@xmlns": {
"type": "object",
"properties": {
"ops": {
"type": "string"
},
"$": {
"type": "string"
},
"xlink": {
"type": "string"
}
}
},
"ops:patent-family": {
"type": "object",
"properties": {
"@legal": {
"type": "string"
},
"@total-result-count": {
"type": "string"
},
"ops:publication-reference": {
"type": "object",
"properties": {
"document-id": {
"type": "object",
"properties": {
"@document-id-type": {
"type": "string"
},
"doc-number": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
}
}
}
}
},
"ops:family-member": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@family-id": {
"type": "string"
},
"publication-reference": {
"type": "object",
"properties": {
"document-id": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@document-id-type": {
"type": "string"
},
"country": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
},
"doc-number": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
},
"kind": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
},
"date": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
}
}
}
}
}
},
"application-reference": {
"type": "object",
"properties": {
"@doc-id": {
"type": "string"
},
"document-id": {
"type": "object",
"properties": {
"@document-id-type": {
"type": "string"
},
"country": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
},
"doc-number": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
},
"kind": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
},
"date": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
}
}
}
}
},
"priority-claim": {
"type": "object",
"properties": {
"@sequence": {
"type": "string"
},
"@kind": {
"type": "string"
},
"document-id": {
"type": "object",
"properties": {
"@document-id-type": {
"type": "string"
},
"country": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
},
"doc-number": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
},
"kind": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
},
"date": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
}
}
},
"priority-active-indicator": {
"type": "object",
"properties": {
"$": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"description": "INPADOC patent family — related applications worldwide"
}Connect
Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:
{
"mcpServers": {
"pipeworx": {
"url": "https://pipeworx.io/mcp"
}
}
}Connect to just the epo-ops pack
{
"mcpServers": {
"epo-ops": {
"url": "https://gateway.pipeworx.io/epo-ops/mcp"
}
}
}See Getting Started for client-specific install steps.