You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+81-1Lines changed: 81 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,28 @@ To run the MCP server directly, use the `uv tool` interface:
20
20
uvx postcode-eu-ai-tools
21
21
```
22
22
23
-
This starts the server on stdio transport. Connect via an MCP client (e.g., Claude Desktop or compatible tools) to use the address validation functions.
23
+
This starts the server on STDIO transport.
24
+
25
+
### Connect MCP clients
26
+
27
+
Use the address validation tools in any client that supports local MCP servers. Just add the `uvx postcode-eu-ai-tools` command to your configuration.
28
+
29
+
Example configuration for Claude Code:
30
+
31
+
```json
32
+
{
33
+
"mcpServers": {
34
+
"postcode-eu-address-validation": {
35
+
"command": "uvx",
36
+
"args": ["postcode-eu-ai-tools"],
37
+
"env": {
38
+
"POSTCODE_EU_API_KEY": "your_api_key",
39
+
"POSTCODE_EU_API_SECRET": "your_api_secret"
40
+
}
41
+
}
42
+
}
43
+
}
44
+
```
24
45
25
46
## Configuration
26
47
@@ -50,24 +71,83 @@ Look up a Dutch address by postcode (e.g., "1234AB") and house number (e.g., "69
50
71
51
72
See https://developer.postcode.eu/documentation/nl/v1/Address/viewByPostcode
52
73
74
+
**Examples**:
75
+
76
+
User:
77
+
> What is the address for postcode 2012es with house number 30?
78
+
79
+
Assistant:
80
+
>Julianastraat 30
81
+
2012ES Haarlem
82
+
Noord-Holland, Netherlands
83
+
84
+
User:
85
+
>What is the address for 2161AM with house number 166b?
Valid additions: "" (166) or "A" (166 A). Which one?
90
+
91
+
User:
92
+
>Is the address 1000AA 1 a PO box?
93
+
94
+
Assistant:
95
+
>Yes, Postbus 1, 1000AA Amsterdam, Noord-Holland, Netherlands (addressType: "PO box").
96
+
53
97
### validate_address
54
98
55
99
Validate and complete an international address. Returns the first match if valid (meaning it's a full address that closely corresponds to the input). Otherwise returns an error message describing why the address is invalid. Partial addresses are considered invalid.
56
100
57
101
See https://developer.postcode.eu/documentation/international/v1/Validate/validate
58
102
103
+
**Examples**:
104
+
105
+
User:
106
+
>Can you validate the address "leystraat 11 2000 antwerpen"?
107
+
108
+
Assistant:
109
+
>Leysstraat 11
110
+
2000 Antwerpen
111
+
Belgium
112
+
Validated (grade B, building level).
113
+
114
+
User:
115
+
>How about "Kirsten Flagstads plass 1" in Oslo?
116
+
117
+
Assistant:
118
+
>Kirsten Flagstads plass 1
119
+
0150 Oslo
120
+
Norway
121
+
Validated (grade A, building level).
122
+
59
123
### get_supported_countries
60
124
61
125
List countries that are supported for address validation.
62
126
63
127
See https://developer.postcode.eu/documentation/international/v1/Autocomplete/getSupportedCountries
64
128
129
+
**Example**:
130
+
131
+
User:
132
+
>For which countries can you validate addresses?
133
+
134
+
Assistant:
135
+
>Netherlands, Belgium, Germany, Luxembourg, Austria, Switzerland, France, United Kingdom, Spain, Denmark, Norway, Finland, Sweden.
136
+
65
137
### is_supported_country
66
138
67
139
Check if a country is supported for address validation.
68
140
69
141
See https://developer.postcode.eu/documentation/international/v1/Autocomplete/getSupportedCountries
0 commit comments