@allratestoday/mcp-server 0.3.3 → 0.3.4

package/README.md

@@ -1,4 +1,4 @@
-# Realtime Exchange Rate MCP Server
+# AllRatesToday MCP Server
 
 [![npm version](https://img.shields.io/npm/v/@allratestoday/mcp-server.svg?style=flat-square)](https://www.npmjs.com/package/@allratestoday/mcp-server)
 [![npm downloads](https://img.shields.io/npm/dm/@allratestoday/mcp-server.svg?style=flat-square)](https://www.npmjs.com/package/@allratestoday/mcp-server)
@@ -9,7 +9,7 @@ English | [简体中文](./README-zh-CN.md)
 
 > Give your AI coding assistant a live window into the foreign-exchange market.
 
-A Model Context Protocol server that lets **Claude Code**, **Cursor**, **Claude Desktop**, **Windsurf**, and any other MCP-compatible client fetch real-time currency rates, historical data, and multi-currency lookups.
+A Model Context Protocol server that lets **Claude Code**, **Cursor**, **Claude Desktop**, **Windsurf**, and any other MCP-compatible client fetch real-time currency rates, historical data, and multi-currency lookups from the [AllRatesToday API](https://allratestoday.com).
 
 After installation, your assistant can answer questions like:
 
@@ -35,6 +35,7 @@ After installation, your assistant can answer questions like:
 - [Verify it works](#verify-it-works)
 - [Tools reference](#tools-reference)
 - [Environment variables](#environment-variables)
+- [Plans and limits](#plans-and-limits)
 - [Troubleshooting](#troubleshooting)
 - [Error reference](#error-reference)
 - [FAQ](#faq)
@@ -51,6 +52,7 @@ After installation, your assistant can answer questions like:
 |---|---|
 | **Currencies** | 150+ ISO 4217 codes, all major and most exotics |
 | **Update frequency** | Mid-market rates refresh every ~60 seconds |
+| **Data source** | Tier-1 financial data providers (Reuters / Refinitiv-class) |
 | **Historical depth** | Up to 1 year via `1d` / `7d` / `30d` / `1y` granularity |
 | **Tools exposed** | 4 — `get_exchange_rate`, `get_historical_rates`, `get_rates_authenticated`, `list_currencies` |
 | **Transport** | stdio (subprocess), MCP 1.x compatible |
@@ -60,14 +62,14 @@ After installation, your assistant can answer questions like:
 
 ## Get an API key (required)
 
-The server **will not start** without a valid `ALLRATES_API_KEY`. Rates are served by [AllRatesToday](https://allratestoday.com); a free key is enough for development and personal use.
+The server **will not start** without a valid `ALLRATES_API_KEY`. A free key is enough for development and personal use — **no credit card required**.
 
-1. Register at [allratestoday.com/register](https://allratestoday.com/register)
+1. Register at [allratestoday.com/register](https://allratestoday.com/register) — 30 seconds
 2. Verify your email
 3. Copy your key from the dashboard (format: `art_live_xxxxx`)
 4. Use it as `ALLRATES_API_KEY` in the configs below
 
-If the key is missing, the server prints clear registration instructions on stderr and exits with code 1.
+If you forget, the server prints clear registration instructions on stderr and exits with code 1.
 
 ---
 
@@ -203,7 +205,7 @@ After configuring your client, test in this order:
 
 ## Tools reference
 
-All four tools require an API key.
+All four tools require `ALLRATES_API_KEY`.
 
 ### `get_exchange_rate`
 
@@ -332,13 +334,19 @@ You set these in your MCP client's config (in the `env` block) — not in your s
 
 ---
 
+## Plans
+
+A free tier and paid plans are available. See [allratestoday.com/pricing](https://allratestoday.com/pricing) for current quotas. All plans include the same currency coverage and historical depth — only the request quotas differ.
+
+---
+
 ## Troubleshooting
 
 | Symptom | Likely cause | Fix |
 |---|---|---|
 | Client shows "MCP server failed to start" or red dot | `ALLRATES_API_KEY` not set or invalid | Verify the key in your client config; check it matches the dashboard |
-| Tools show but every call returns "Invalid API key" | Key is malformed (missing prefix, truncated, or revoked) | Copy a fresh key from the dashboard |
-| Tools return "API quota exceeded" | Plan request limit hit | Wait until next month or upgrade plan |
+| Tools show but every call returns "Invalid AllRatesToday API key" | Key is malformed (missing prefix, truncated, or revoked) | Copy a fresh key from the dashboard |
+| Tools return "AllRatesToday API quota exceeded" | Free-tier monthly limit hit | Wait until next month or upgrade plan |
 | Historical tool returns "Bad request" | Invalid period or unknown currency code | Period must be `1d`/`7d`/`30d`/`1y`; codes must be 3 letters |
 | Server starts but tools never appear in client | Client didn't reload after config change | Fully quit (not just close) and reopen the client |
 | `npx` runs but hangs forever | The server is waiting for an MCP client to connect — this is normal when run from a shell | Don't run from a shell; let your MCP client launch it |
@@ -363,9 +371,9 @@ The server maps API errors to clear, actionable messages.
 |---|---|---|
 | 200 | Success | (rate returned) |
 | 400 | Bad request — usually unknown currency code | `Bad request — possibly an unknown currency code` |
-| 401 | Invalid or missing API key | `Invalid API key` |
-| 429 | Quota exceeded | `API quota exceeded` |
-| 5xx | Upstream server-side issue | `HTTP 5xx — <upstream message>` |
+| 401 | Invalid or missing API key | `Invalid AllRatesToday API key` |
+| 429 | Quota exceeded | `AllRatesToday API quota exceeded` |
+| 5xx | Server-side issue at allratestoday.com | `HTTP 5xx — <upstream message>` |
 
 The LLM will surface these messages in its response, so a user prompt that hits a 429 results in the assistant saying *"the API quota has been exceeded — please try again next month or upgrade your plan."*
 
@@ -373,20 +381,23 @@ The LLM will surface these messages in its response, so a user prompt that hits
 
 ## FAQ
 
+**Is the free plan really enough for normal use?**
+Yes for personal/dev use. The free tier covers a few daily questions. Heavy interactive use, multiple chat sessions per day, or running the server in production should consider the paid tiers.
+
 **Do you store my conversation or query data?**
-No. Only your API key and the request parameters (source, target, period, time) are sent to the upstream API — never the LLM's conversation context, sheet contents, or anything else.
+No. Only your API key and the request parameters (source, target, period, time) are sent to allratestoday.com — never the LLM's conversation context, sheet contents, or anything else.
 
 **What happens to my API key?**
-It's only sent as a `Bearer` token in the `Authorization` header on requests to the upstream API. It's never logged or transmitted elsewhere.
+It's only sent as a `Bearer` token in the `Authorization` header on requests to the AllRatesToday API. It's never logged or transmitted elsewhere.
 
 **Why is my historical request slow on first call?**
-Cold-start of `npx` (first run downloads the package) plus an initial upstream cache miss. Subsequent calls are fast (<200ms typically).
+Cold-start of `npx` (first run downloads the package) plus the initial AllRatesToday cache miss. Subsequent calls are fast (<200ms typically).
 
 **Can I run this without npm/Node?**
 Not currently — Node ≥18 is required. We've considered a standalone binary; if that matters to you, open an issue.
 
 **Is there a self-hosted option?**
-Yes, set `ALLRATES_BASE_URL` to point to your own instance.
+Yes, set `ALLRATES_BASE_URL` to your own AllRatesToday instance. Contact support@allratestoday.com for self-hosted licensing.
 
 **Does this work with ChatGPT?**
 The Anthropic MCP standard works with any MCP-compatible client. ChatGPT Desktop has experimental MCP support; check OpenAI's docs for current status.
@@ -396,8 +407,8 @@ The Anthropic MCP standard works with any MCP-compatible client. ChatGPT Desktop
 ## Development
 
 ```bash
-git clone https://github.com/cahthuranag/realtime-exchange-rate-mcp.git
-cd realtime-exchange-rate-mcp
+git clone https://github.com/cahthuranag/mcp-server.git
+cd mcp-server
 npm install
 npm run build
 ALLRATES_API_KEY=art_live_xxxxx node dist/index.js
@@ -411,7 +422,7 @@ To watch and rebuild on changes during development:
 npm run dev
 ```
 
-To test against a local instance:
+To test against a local AllRatesToday instance:
 
 ```bash
 ALLRATES_BASE_URL=http://localhost:8080/api ALLRATES_API_KEY=test_key node dist/index.js
@@ -422,7 +433,7 @@ ALLRATES_BASE_URL=http://localhost:8080/api ALLRATES_API_KEY=test_key node dist/
 ```
 src/
 ├── index.ts      # MCP server, tool registration, request handlers
-└── client.ts     # HTTP client + error mapping
+└── client.ts     # HTTP client for AllRatesToday API + error mapping
 dist/             # Compiled JS (gitignored)
 server.json       # MCP registry manifest
 package.json      # npm metadata, dependencies, scripts
@@ -430,10 +441,10 @@ package.json      # npm metadata, dependencies, scripts
 
 ### Contributing
 
-Issues and PRs welcome at [github.com/cahthuranag/realtime-exchange-rate-mcp](https://github.com/cahthuranag/realtime-exchange-rate-mcp). Before opening a PR:
+Issues and PRs welcome at [github.com/cahthuranag/mcp-server](https://github.com/cahthuranag/mcp-server). Before opening a PR:
 
 1. `npm run build` should succeed with no errors
-2. Test against a real API key (set in `ALLRATES_API_KEY`)
+2. Test against a real AllRatesToday API key (set in `ALLRATES_API_KEY`)
 3. Update tool descriptions in `src/index.ts` if you change tool behavior
 4. Update this README's "Tools reference" section if you add or rename a tool
 
@@ -441,7 +452,7 @@ Issues and PRs welcome at [github.com/cahthuranag/realtime-exchange-rate-mcp](ht
 
 ## Changelog
 
-See [GitHub Releases](https://github.com/cahthuranag/realtime-exchange-rate-mcp/releases) for the full list. Recent highlights:
+See [GitHub Releases](https://github.com/cahthuranag/mcp-server/releases) for the full list. Recent highlights:
 
 - **0.3.x** — API key required for all tools; fail-fast at startup with clear error
 - **0.2.x** — Removed news tool, required auth on `get_historical_rates`
@@ -451,8 +462,10 @@ See [GitHub Releases](https://github.com/cahthuranag/realtime-exchange-rate-mcp/
 
 ## Support
 
-- **Bug reports**: [github.com/cahthuranag/realtime-exchange-rate-mcp/issues](https://github.com/cahthuranag/realtime-exchange-rate-mcp/issues)
+- **API issues**: [support@allratestoday.com](mailto:support@allratestoday.com)
+- **Bug reports**: [github.com/cahthuranag/mcp-server/issues](https://github.com/cahthuranag/mcp-server/issues)
 - **MCP questions**: [modelcontextprotocol.io](https://modelcontextprotocol.io) — protocol docs
+- **Status / uptime**: [allratestoday.com](https://allratestoday.com) (status page in development)
 
 ---
 

package/dist/client.js

@@ -30,7 +30,7 @@ export class AllRatesTodayClient {
             'User-Agent': USER_AGENT,
         };
         if (!this.apiKey) {
-            throw new AllRatesTodayError('API key is required. Get one at https://allratestoday.com/register, then set ALLRATES_API_KEY in your MCP config.');
+            throw new AllRatesTodayError('AllRatesToday API key is required. Sign up free at https://allratestoday.com/register to get a key, then set ALLRATES_API_KEY in your MCP config.');
         }
         headers['Authorization'] = `Bearer ${this.apiKey}`;
         const res = await this.fetchImpl(url.toString(), { method: 'GET', headers });

package/dist/index.js

@@ -12,7 +12,7 @@ const CCY = {
 const tools = [
     {
         name: 'get_exchange_rate',
-        description: 'Get the current mid-market exchange rate between two currencies. Returns a single rate number. Requires API key (ALLRATES_API_KEY).',
+        description: 'Get the current mid-market exchange rate between two currencies. Returns a single rate number. Requires a free AllRatesToday API key (ALLRATES_API_KEY) — sign up at https://allratestoday.com/register.',
         inputSchema: {
             type: 'object',
             additionalProperties: false,
@@ -25,7 +25,7 @@ const tools = [
     },
     {
         name: 'get_historical_rates',
-        description: 'Get historical exchange-rate data points for a currency pair over a period. Periods: 1d (hourly), 7d (daily), 30d (daily), 1y (weekly). Requires API key (ALLRATES_API_KEY).',
+        description: 'Get historical exchange-rate data points for a currency pair over a period. Periods: 1d (hourly), 7d (daily), 30d (daily), 1y (weekly). Requires an AllRatesToday API key (ALLRATES_API_KEY).',
         inputSchema: {
             type: 'object',
             additionalProperties: false,
@@ -44,7 +44,7 @@ const tools = [
     },
     {
         name: 'get_rates_authenticated',
-        description: 'Get rates with higher limits and multi-target support. Requires API key (ALLRATES_API_KEY). Supports comma-separated targets like "EUR,GBP,JPY".',
+        description: 'Get rates with higher limits and multi-target support. Requires an AllRatesToday API key (ALLRATES_API_KEY). Supports comma-separated targets like "EUR,GBP,JPY".',
         inputSchema: {
             type: 'object',
             additionalProperties: false,
@@ -70,7 +70,7 @@ const tools = [
     },
     {
         name: 'list_currencies',
-        description: 'List all supported currencies with code, name, and symbol. Requires API key (ALLRATES_API_KEY). Cached 24h upstream.',
+        description: 'List all supported currencies with code, name, and symbol. Requires a free AllRatesToday API key (ALLRATES_API_KEY) — sign up at https://allratestoday.com/register. Cached 24h upstream.',
         inputSchema: { type: 'object', additionalProperties: false, properties: {} },
     },
 ];
@@ -83,9 +83,9 @@ async function main() {
     if (!apiKey) {
         console.error([
             '',
-            '  This MCP server requires an API key.',
+            '  AllRatesToday MCP server requires an API key.',
             '',
-            '  1. Get a free key at https://allratestoday.com/register',
+            '  1. Sign up free at https://allratestoday.com/register (300 requests/month, no card required)',
             '  2. Copy your API key from the dashboard',
             '  3. Set ALLRATES_API_KEY in your MCP client config:',
             '',
@@ -102,7 +102,7 @@ async function main() {
         apiKey,
         baseUrl: process.env.ALLRATES_BASE_URL,
     });
-    const server = new Server({ name: 'realtime-exchange-rate-mcp', version: '0.3.2' }, { capabilities: { tools: {} } });
+    const server = new Server({ name: 'allratestoday-mcp', version: '0.3.1' }, { capabilities: { tools: {} } });
     server.setRequestHandler(ListToolsRequestSchema, async () => ({ tools }));
     server.setRequestHandler(CallToolRequestSchema, async (req) => {
         const { name, arguments: args = {} } = req.params;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@allratestoday/mcp-server",
-  "version": "0.3.3",
-  "mcpName": "io.github.cahthuranag/realtime-exchange-rate-mcp",
-  "description": "MCP server that lets AI coding tools (Claude Code, Cursor, Claude Desktop) fetch real-time and historical currency exchange rates.",
+  "version": "0.3.4",
+  "mcpName": "io.github.cahthuranag/mcp-server",
+  "description": "MCP server for AllRatesToday — let AI coding tools (Claude Code, Cursor, Claude Desktop) fetch real-time and historical currency exchange rates.",
   "keywords": [
     "mcp",
     "model-context-protocol",
@@ -10,15 +10,16 @@
     "cursor",
     "currency",
     "exchange-rate",
-    "forex"
+    "forex",
+    "allratestoday"
   ],
   "license": "MIT",
-  "homepage": "https://github.com/cahthuranag/realtime-exchange-rate-mcp",
+  "homepage": "https://allratestoday.com",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/cahthuranag/realtime-exchange-rate-mcp.git"
+    "url": "git+https://github.com/cahthuranag/mcp-server.git"
   },
-  "bugs": "https://github.com/cahthuranag/realtime-exchange-rate-mcp/issues",
+  "bugs": "https://github.com/cahthuranag/mcp-server/issues",
   "type": "module",
   "main": "dist/index.js",
   "bin": {