@uniquedomains/mcp-server 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -11,7 +11,7 @@ Every tool reads stored data as of its day. None registers, buys or changes a na
11
11
 
12
12
  ### Claude
13
13
 
14
- In Claude (web or Desktop), open Settings, then Connectors, add a custom connector and paste `https://mcp.unique.domains/mcp`. No sign-in is needed.
14
+ In Claude (web or Desktop), open Customize, then Connectors, click "+ Add", then "Add custom connector", name it Unique Domains and paste `https://mcp.unique.domains/mcp`. No sign-in is needed. On a Team or Enterprise plan, an Owner adds it in Organization settings, then Connectors, and members connect it from Customize, then Connectors.
15
15
 
16
16
  To run it on your machine instead, add this to Claude Desktop's `claude_desktop_config.json`:
17
17
 
@@ -65,7 +65,7 @@ Or in `.vscode/mcp.json`:
65
65
 
66
66
  ### ChatGPT
67
67
 
68
- With developer mode on (Settings, Apps and Connectors, Advanced settings), create a connector with the URL `https://mcp.unique.domains/mcp` and no authentication.
68
+ Go to [chatgpt.com/plugins](https://chatgpt.com/plugins), select the plus button, then "Add custom MCP server". Name it Unique Domains, enter `https://mcp.unique.domains/mcp` as the server URL with no authentication, then "Create as a plugin". Install the plugin, then in a new conversation type `@` and pick it. Your account's or workspace's policies decide whether custom servers can be added.
69
69
 
70
70
  ### Any other client
71
71
 
@@ -83,16 +83,25 @@ UD_API_KEY=ud_live_your_key npx -y @uniquedomains/mcp-server
83
83
 
84
84
  The server reads the key's plan once at start and lists the tools that plan opens. The plans are described at [unique.domains/api](https://unique.domains/api).
85
85
 
86
- The hosted connector serves the free tools only and takes no key. Three free tools are on the npm server only (`ud_get_market_sales_word`, `ud_get_word_market`, `ud_list_tld_prices`): each answers one word or one ending a caller a day, and the hosted connector is one caller for all its users.
86
+ The hosted connector serves the free tools only and takes no key. Five free tools are on the npm server only. Three answer one word or one ending a caller a day, and the hosted connector is one caller for all its users: `ud_get_market_sales_word`, `ud_get_word_market`, `ud_list_tld_prices`. `ud_get_domain` answers what `ud_get_name` answers, and `ud_get_meta_freshness` reports how current each part of the data is, which every answer's `meta` already dates.
87
87
 
88
88
  ## What an answer holds
89
89
 
90
90
  - `structuredContent`: the API's `data`, `meta` and `links`, as the tool's output schema describes them.
91
91
  - `content`: one line for a reader (the name and its headline fact, or the row count and the first names), then the same JSON as text.
92
92
  - `links.details`: the public Unique Domains page about the subject, when there is one (hosted connector).
93
+ - On the hosted connector, internal ids (catalog ids, row ids, UUIDs) are left out, times become their UTC day (an auction's deadline keeps its hour), and the stamps of when a figure was computed are dropped. The npm server and the API keep them.
93
94
  - A list answers 20 rows by default. When `meta.cursor` is set, pass it as `cursor` to read the next page.
94
95
  - A refusal is a sentence the assistant can act on: what was wrong, what is accepted, or when a limit resets.
95
96
 
97
+ ## Privacy and security
98
+
99
+ - **What the connector logs.** Nothing of its own: it stores no question, no answer and no caller. It passes each tool's input to the Unique Domains API, whose request log keeps one line per call (the path, which holds the name or word asked about, its time, its status and how long it took) for 12 months, after which a monthly job deletes it. The connector's calls carry no address or account of yours. Section 8 of the [privacy policy](https://unique.domains/privacy#api-and-connector) says what the API keeps and why.
100
+ - **Registry records.** A name's registry answer repeats the registry's public record, which can include the holder's name or organization when the registry publishes it.
101
+ - **Every origin is accepted.** `/mcp` answers any `Origin` with `Access-Control-Allow-Origin: *`. The server is public, needs no sign-in, holds no session and never serves a member key over HTTP, so checking the origin would protect nothing, and strict origin checks break some assistants' own clients.
102
+ - **HTTPS only.** The hosted connector answers over HTTPS and sends `Strict-Transport-Security: max-age=31536000`.
103
+ - **Reporting a vulnerability.** Write to [contact@unique.domains](mailto:contact@unique.domains); please do not open a public issue for it.
104
+
96
105
  ## The same data elsewhere
97
106
 
98
107
  - The API reference: [unique.domains/api](https://unique.domains/api)
@@ -103,47 +112,47 @@ The hosted connector serves the free tools only and takes no key. Three free too
103
112
 
104
113
  <!-- tools:start (generated by scripts/generate.mjs) -->
105
114
 
106
- 56 tools answer without a key (53 on the hosted connector); a member key adds 25 more, the Investor ones for an Investor key only.
115
+ 56 tools answer without a key (51 on the hosted connector); a member key adds 25 more, the Investor ones for an Investor key only.
107
116
 
108
117
  | Tool | What it reads | Needs |
109
118
  |---|---|---|
110
119
  | `ud_get_name` | Stored answer for one domain name | free |
111
- | `ud_batch_names` | Keyed name resource for up to 100 names in one call | Investor key |
120
+ | `ud_batch_names` | Stored answers for up to 100 domain names in one call | Investor key |
112
121
  | `ud_check_name` | Reads one name live from its registry and a registrar | member key |
113
122
  | `ud_get_name_prices` | Every stored registrar quote for one name | member key |
114
123
  | `ud_get_name_registry` | Latest stored registry record of one name | free |
115
124
  | `ud_get_name_registry_history` | Stored registry record versions of one name and what moved between them | Investor key |
116
125
  | `ud_get_name_dns` | Latest stored DNS reading of one name | free |
117
126
  | `ud_list_name_changes` | Change events of one name, newest first | Investor key |
118
- | `ud_get_name_history` | Web history of one name as our bands | Investor key |
127
+ | `ud_get_name_history` | Web history of one name in bands | Investor key |
119
128
  | `ud_get_name_value` | Stored value estimate of one name and its last 20 estimates | member key |
120
129
  | `ud_appraise_name` | Runs the appraisal of one stored name when its estimate is missing | Investor key |
121
- | `ud_get_name_comps` | Similar-sales aggregate of one name and the endings its word sold on | free |
130
+ | `ud_get_name_comps` | Similar-sales aggregate of one name and how many endings its word sold on | free |
122
131
  | `ud_get_name_auction` | Open auction of one name, if any | free |
123
132
  | `ud_resolve_word` | Turns what a caller typed into the catalog word it names | free |
124
133
  | `ud_list_word_categories` | Catalog's word categories, by name | free |
125
134
  | `ud_batch_words` | Up to 100 word profiles in one call | Investor key |
126
135
  | `ud_list_words` | Searches the catalog's words by text and facets | member key |
127
136
  | `ud_get_word` | A word's profile | member key |
128
- | `ud_get_word_endings` | A word's endings as the nightly update holds them | free |
137
+ | `ud_get_word_endings` | A word's endings as stored on the latest day | free |
129
138
  | `ud_list_word_names` | A word's catalog names on the endings that sell, by name | member key |
130
139
  | `ud_get_word_trademarks` | A word's trademark counts and its exact-match marks | Investor key |
131
140
  | `ud_get_word_notability` | A word's Wikipedia and Wikidata facts | free |
132
- | `ud_get_word_market` | A word's sales and auction aggregates from the nightly update | free, npm only |
141
+ | `ud_get_word_market` | A word's stored sales and auction aggregates | free, npm only |
133
142
  | `ud_list_related_words` | A word's synonyms then related words | Investor key |
134
143
  | `ud_list_word_fits` | How well the word fits each ending whose keywords list it | Investor key |
135
144
  | `ud_request_word` | Brings a word into the catalog | Investor key |
136
145
  | `ud_get_word_request` | State of a word request | Investor key |
137
146
  | `ud_list_domains` | One-word catalog names under filters | free |
138
- | `ud_get_domain` | One catalog name, by name or id | free |
147
+ | `ud_get_domain` | One catalog name, by name or catalog id | free, npm only |
139
148
  | `ud_list_expiring_domains` | Catalog names expiring or expired, by expiry day | Investor key |
140
- | `ud_get_domain_drops` | Names dropping on one day | free |
149
+ | `ud_get_domain_drops` | Names dropping on one day, counted by ending | free |
141
150
  | `ud_list_domain_hacks` | Domain hacks | free |
142
- | `ud_list_domain_changes` | Catalog's change feed, newest first | Investor key |
151
+ | `ud_list_domain_changes` | Changes across the catalog's names, newest first | Investor key |
143
152
  | `ud_get_catalog_stats` | Catalog headline totals for the latest day | free |
144
153
  | `ud_list_tlds` | Every root TLD with its registry facts and launch phases | free |
145
154
  | `ud_get_tld` | One TLD in full | free |
146
- | `ud_get_tld_stats` | Ending's latest market rollup | free |
155
+ | `ud_get_tld_stats` | Ending's latest market figures | free |
147
156
  | `ud_list_tld_phases` | Every dated launch phase of the ending, chronological | free |
148
157
  | `ud_list_tld_changes` | Ending's public registry changes, newest first | free |
149
158
  | `ud_list_tld_keywords` | Keywords the catalog attaches to the ending, by type | free |
@@ -161,7 +170,7 @@ The hosted connector serves the free tools only and takes no key. Three free too
161
170
  | `ud_list_cheapest_prices` | Cheapest registrar per ending for up to 100 endings | member key |
162
171
  | `ud_list_venues` | Parking and marketplace venues with a profile and their rounded footprint | free |
163
172
  | `ud_get_venue` | One venue's profile with its verified listing terms | free |
164
- | `ud_list_iana_registrars` | IANA registrar list as the registry sync stores it | free |
173
+ | `ud_list_iana_registrars` | IANA registrar list as stored, by IANA id | free |
165
174
  | `ud_get_iana_registrar` | One IANA registrar by id | free |
166
175
  | `ud_get_market_sales` | Domain sales pulse as headline aggregates | free |
167
176
  | `ud_list_market_sales_series` | One sales series by day, week or month, oldest first | free |
@@ -170,24 +179,24 @@ The hosted connector serves the free tools only and takes no key. Three free too
170
179
  | `ud_list_market_sales_movers` | Up to ten words whose sales moved over the last 30 days | free |
171
180
  | `ud_get_market_sales_word` | One word's sales market over 12 months | free, npm only |
172
181
  | `ud_get_market_auctions` | Today's domain auctions by venue | free |
173
- | `ud_list_market_auctions_sample` | Day's frozen sample of up to 20 single-word names at auction | free |
182
+ | `ud_list_market_auctions_sample` | Day's fixed sample of up to 20 single-word names at auction | free |
174
183
  | `ud_list_market_auction_venues` | Seven auction venues with their verified rules and today's counts | free |
175
184
  | `ud_list_market_auction_outcomes` | Confirmed auction outcomes by venue | Investor key |
176
185
  | `ud_list_trends` | Every published trend with its latest edition figures and its first and last edition day | free |
177
186
  | `ud_get_trend` | One trend | free |
178
- | `ud_list_trend_categories` | Trend categories, the `category` filter of `GET /trends` | free |
179
- | `ud_list_trend_pool` | Admitted trend candidates the editions draw from | member key |
187
+ | `ud_list_trend_categories` | Trend categories, to narrow the trends by | free |
188
+ | `ud_list_trend_pool` | Trend candidates the daily editions draw from | member key |
180
189
  | `ud_list_events` | Industry events of one month | free |
181
190
  | `ud_get_event` | One industry event with its organizer | free |
182
191
  | `ud_get_agenda` | Whole public agenda of one month | free |
183
- | `ud_get_latest_edition` | Latest published daily edition of one page | free |
184
- | `ud_get_edition` | One dated published edition of one page | free |
185
- | `ud_get_meta_enums` | Every enum the payloads use, read from the code catalogs | free |
186
- | `ud_get_meta_freshness` | How current the scanner's passes are | free |
187
- | `ud_list_meta_datasets` | GitHub datasets and the API path serving the same rows | free |
192
+ | `ud_get_latest_edition` | Latest daily edition of Business Ideas or Trending Domains | free |
193
+ | `ud_get_edition` | One dated daily edition of Business Ideas or Trending Domains | free |
194
+ | `ud_get_meta_enums` | Every list of values the answers use | free |
195
+ | `ud_get_meta_freshness` | How current each part of the stored data is | free, npm only |
196
+ | `ud_list_meta_datasets` | Free GitHub datasets that hold the same rows as these answers | free |
188
197
  | `ud_list_meta_trademark_classes` | 45 Nice classes a trademark is filed under | free |
189
198
  | `ud_get_meta_providers` | Registrar identities and the auction venue and parking service catalogs | free |
190
- | `ud_get_key` | Calling key's own plan, allowances and month | member key |
199
+ | `ud_get_key` | What the calling member key opens | member key |
191
200
 
192
201
  <!-- tools:end -->
193
202
 
@@ -221,7 +230,7 @@ docker build -t uniquedomains-mcp-server .
221
230
  docker run -p 8080:8080 uniquedomains-mcp-server
222
231
  ```
223
232
 
224
- The image runs `node dist/http.js` with `UD_MCP_PROFILE=hosted`: `POST /mcp` (stateless Streamable HTTP, plain JSON answers), `GET /healthz`, and the well-known files. Every answer is `Cache-Control: no-store`, and `/mcp` allows any origin.
233
+ The image runs `node dist/http.js` with `UD_MCP_PROFILE=hosted`: `POST /mcp` (stateless Streamable HTTP, plain JSON answers), `GET /healthz`, and the well-known files. Every answer is `Cache-Control: no-store` with `Strict-Transport-Security: max-age=31536000`, and `/mcp` allows any origin (its preflight offers `POST` and `OPTIONS`).
225
234
 
226
235
  The same image speaks stdio when given the stdio entry, for catalogs that inspect a server that way:
227
236
 
@@ -240,7 +249,7 @@ npm run smoke
240
249
 
241
250
  - `npm run generate` rebuilds `src/generated/tools.ts`, `openapi/v1.json` and the tool list above from the API document that `@uniquedomains/sdk` ships; `-- --check` fails when they are out of date, `-- --live` compares the live document.
242
251
  - `npm run smoke` runs the MCP Inspector against both transports and a fixture API; `-- --live` uses the live API.
243
- - `npm run plugin` builds `dist/chatgpt-plugin.zip` and checks it against OpenAI's limits; it refuses while `plugin/review.json` holds placeholder texts (`npm run plugin:test` builds anyway, for CI).
252
+ - `npm run plugin` builds `dist/chatgpt-plugin.zip` from `plugin/review.json` (the review texts, the test cases, the release notes) and checks it against OpenAI's limits and categories; `npm run plugin:test` also builds a sheet marked as a placeholder.
244
253
  - The nightly contract workflow opens its pull request with the workflow token, which needs the repository setting "Allow GitHub Actions to create and approve pull requests" (Settings, Actions, General).
245
254
 
246
255
  ## License