@commoditypriceapi/mcp 1.1.0 → 1.2.1

package/README.md

@@ -221,7 +221,9 @@ Try these after setup:
 
 ## Tool Reference
 
-All 8 tools map 1:1 to CommodityPriceAPI v3 endpoints. Tools that take `symbols` accept a comma-separated list (e.g. `XAU,XAG,BRENTOIL-SPOT`). Use `list_symbols` to look up valid symbols — there are 148 across Metals, Energy, Agriculture, and more.
+All 8 tools map 1:1 to CommodityPriceAPI v3 endpoints. Tools that take `symbols` accept a comma-separated list (e.g. `XAU,XAG,XPT,BRENTOIL-SPOT`). Use `list_symbols` to look up valid symbols — there are 245 across Metals, Energy, Agriculture, and more.
+
+Precious metals use ISO 4217 codes: `XAU` (gold), `XAG` (silver), `XPT` (platinum), `XPD` (palladium). Copper is `XCU`. The retired codes `PL`, `PA`, and `HG` still work on v3 — they are auto-resolved to the new symbol (see the note below).
 
 ### get_latest_rates
 
@@ -231,8 +233,15 @@ All 8 tools map 1:1 to CommodityPriceAPI v3 endpoints. Tools that take `symbols`
 |-----------|----------|-------------|
 | `symbols` | Yes | Comma-separated symbols, e.g. `XAU,XAG,BRENTOIL-SPOT` |
 | `quote` | No | Target quote currency (e.g. `EUR`). Premium/Plus plans only; omit for each symbol's default currency. |
+| `metadata` | No | `true` (default) or `false`. `false` omits the `metadata` map (per-symbol unit and quote currency) from the response. |
+
+Note on `unresolved`: v3 appends an `unresolved` map, keyed by the symbol you typed, in three cases. The same applies to `get_historical_rates`, `get_time_series`, and `get_fluctuation`.
 
-Note: if some symbols in a multi-symbol request are invalid, the API returns the valid rates (HTTP 206) plus an `unresolved` map — one entry per missing symbol with a message and, where available, `suggestions` ("did you mean"). If no symbol resolves, the tool returns a `SYMBOL_NOT_FOUND` error carrying the same `unresolved` map. The same applies to `get_historical_rates`, `get_time_series`, and `get_fluctuation`.
+| Case | HTTP | What the entry holds |
+|------|------|----------------------|
+| Symbol is not a catalogue code but has exactly one match (e.g. `GOLD`, or retired `PL`) | `200` | `message` + `resolvedTo` — the rate was returned under `resolvedTo` in `rates`. Informational, not a failure. |
+| Some symbols could not be returned | `206` | `message` + optional `suggestions` ("did you mean"). Valid rates are still in `rates`. |
+| No symbol resolved | `404` | Tool returns a `SYMBOL_NOT_FOUND` error carrying the same `unresolved` map. |
 
 ### get_gold_price
 
@@ -241,14 +250,18 @@ Note: if some symbols in a multi-symbol request are invalid, the API returns the
 | Parameter | Required | Description |
 |-----------|----------|-------------|
 | `quote` | No | Target quote currency. Premium/Plus plans only. |
+| `include` | No | `gram`, `carat`, or `tola` — adds a per-gram rate, per-gram rates at each purity from 24k to 8k, or a per-tola rate alongside the ounce rate. |
+| `metadata` | No | `true` (default) or `false`. `false` omits the `metadata` map (per-symbol unit and quote currency) from the response. |
 
 ### get_silver_price
 
-`GET /v3/rates/latest/xag` — shortcut for the latest silver (XAG) rate.
+`GET /v3/rates/latest/xag` — shortcut for the latest silver (XAG) rate, including bid/ask.
 
 | Parameter | Required | Description |
 |-----------|----------|-------------|
 | `quote` | No | Target quote currency. Premium/Plus plans only. |
+| `include` | No | `gram`, `carat`, or `tola` — adds a per-gram, per-carat, or per-tola rate alongside the ounce rate. |
+| `metadata` | No | `true` (default) or `false`. `false` omits the `metadata` map (per-symbol unit and quote currency) from the response. |
 
 ### get_historical_rates
 
@@ -292,7 +305,8 @@ Note: if some symbols in a multi-symbol request are invalid, the API returns the
 ### Live prices
 
 - What's the current gold price?
-- Get the latest prices for silver, copper, and WTI crude.
+- What's gold per gram right now?
+- Get the latest prices for silver, platinum, copper, and WTI crude.
 - What's gold trading at in euros?
 
 ### Historical data
@@ -385,6 +399,35 @@ The text answers show what a client might say; exact wording depends on the mode
 }
 ```
 
+### Auto-resolved symbol
+
+**Prompt:** What's the price of GOLD and platinum?
+
+**Example answer:** Gold (XAU) is $4,386.23 and platinum (XPT) is $1,412.50 per troy ounce. Note: `GOLD` isn't a symbol code, so the API returned it under `XAU`.
+
+```json
+{
+  "success": true,
+  "timestamp": 1786617187,
+  "rates": {
+    "XAU": 4386.23,
+    "XPT": 1412.5
+  },
+  "metadata": {
+    "XAU": { "unit": "T.oz", "quote": "USD" },
+    "XPT": { "unit": "T.oz", "quote": "USD" }
+  },
+  "unresolved": {
+    "GOLD": {
+      "message": "GOLD is not a symbol code used by this API. Gold is available as \"XAU\", so its rate was returned under that symbol.",
+      "resolvedTo": "XAU"
+    }
+  }
+}
+```
+
+Status is `200` — an entry with `resolvedTo` never downgrades the response.
+
 ## Error Codes
 
 Tool calls never crash the server. Upstream errors are returned as structured tool results with `error`, `code`, `message`, and a `guidance` field so the client can explain what went wrong instead of echoing a status code.
@@ -457,7 +500,7 @@ COMMODITYPRICEAPI_KEY=<YOUR_KEY> npx @modelcontextprotocol/inspector node dist/c
 
 **401 errors:** Check that `COMMODITYPRICEAPI_KEY` is set in your MCP client config's `env` block.
 
-**A symbol is missing from a multi-symbol response:** Look at the `unresolved` map in the result — each missing symbol has a message and usually `suggestions` (e.g. `BRENTOIL` → `BRENTOIL-SPOT`). If there are no suggestions, call `list_symbols` to find the correct symbol.
+**A symbol is missing from a multi-symbol response:** Look at the `unresolved` map in the result. If the entry has `resolvedTo`, nothing is missing — the rate is in `rates` under that symbol (e.g. `GOLD` → `XAU`, `PL` → `XPT`). Otherwise each missing symbol has a message and usually `suggestions` (e.g. `OIL` → `WTIOIL-SPOT`, `BRENTOIL-SPOT`, …). If there are no suggestions, call `list_symbols` to find the correct symbol.
 
 **499 timeouts:** The upstream API did not respond in time. Increase `COMMODITYPRICEAPI_REQUEST_TIMEOUT_MS` (default: 15000 ms).
 

package/dist/client.js

@@ -26,8 +26,10 @@ function getApiKey() {
  * param, since the upstream API accepts either.
  *
  * v3 answers 206 (still `response.ok`) with an `unresolved` map appended to
- * the body when some requested symbols could not be returned; the body is
- * passed through as-is so tool results include those suggestions.
+ * the body when some requested symbols could not be returned, and 200 with an
+ * `unresolved` map when a symbol was auto-resolved to its single match
+ * (`resolvedTo`). The body is passed through as-is so tool results include
+ * those notes and suggestions.
  */
 export async function callCommodityApi(path, params = {}) {
     const apiKey = getApiKey();

package/dist/server.js

@@ -3,8 +3,28 @@ import { z } from "zod";
 import { callCommodityApi, CommodityApiError } from "./client.js";
 const symbolsParam = z
     .string()
-    .describe("Comma-separated commodity symbols, e.g. 'XAU,XAG,BRENTOIL-SPOT'. See the list_symbols tool for valid values. If some symbols cannot be resolved, the response still succeeds (HTTP 206) with the valid rates plus an 'unresolved' map giving a message and 'did you mean' suggestions for each missing symbol. If none resolve, the error result carries the same 'unresolved' map.");
+    .describe("Comma-separated commodity symbols, e.g. 'XAU,XAG,XPT,BRENTOIL-SPOT'. Precious metals use ISO 4217 codes (XAU gold, XAG silver, XPT platinum, XPD palladium); copper is XCU. See the list_symbols tool for valid values. " +
+    "The response may include an 'unresolved' map keyed by the symbol you typed. Three cases: " +
+    "(1) HTTP 200 with an entry carrying 'resolvedTo' — the symbol was not a catalogue code but had exactly one match (e.g. GOLD -> XAU, retired PL -> XPT), so its rate was returned under the 'resolvedTo' symbol in 'rates'; this is informational, not a failure. " +
+    "(2) HTTP 206 — some symbols could not be returned; each entry has a message and, where available, 'did you mean' suggestions, while the valid rates are still in 'rates'. " +
+    "(3) If none resolve, the error result carries the same 'unresolved' map.");
 const dateParam = z.string().describe("Date in YYYY-MM-DD format.");
+const quoteParam = z
+    .string()
+    .optional()
+    .describe("Target quote currency code (e.g. 'USD', 'EUR'). Premium/Plus plans only; omit to use each symbol's default currency.");
+const includeParam = z
+    .enum(["gram", "carat", "tola"])
+    .optional()
+    .describe("Add a per-unit breakdown alongside the per-troy-ounce rate: 'gram' adds a per-gram rate, 'tola' adds a per-tola rate, 'carat' adds per-gram rates at each purity from 24k down to 8k. Omit for the ounce rate only.");
+const metadataParam = z
+    .boolean()
+    .optional()
+    .describe("Whether to include the 'metadata' map (per-symbol unit and quote currency) in the response. Defaults to true. Set false to omit it and get a smaller payload.");
+/** v3 only honours an explicit `metadata=false`; anything else is the default (true). */
+function metadataFlag(metadata) {
+    return metadata === false ? "false" : undefined;
+}
 function textResult(data) {
     return {
         content: [
@@ -65,7 +85,7 @@ function guidanceFor(code, errorType) {
 export function createServer() {
     const server = new McpServer({
         name: "commoditypriceapi-mcp",
-        version: "1.1.0",
+        version: "1.2.1",
     });
     server.registerTool("get_usage", {
         title: "Get API usage",
@@ -82,7 +102,7 @@ export function createServer() {
     });
     server.registerTool("list_symbols", {
         title: "List supported commodity symbols",
-        description: "Returns all commodity symbols supported by CommodityPriceAPI, including category, default currency, and unit. Use this to look up a symbol before calling rate tools.",
+        description: "Returns all commodity symbols supported by CommodityPriceAPI, including category, default currency, and unit. Use this to look up a symbol before calling rate tools. Precious metals use ISO 4217 codes (XAU, XAG, XPT, XPD); copper is XCU.",
         inputSchema: {},
     }, async () => {
         try {
@@ -95,17 +115,19 @@ export function createServer() {
     });
     server.registerTool("get_latest_rates", {
         title: "Get latest commodity rates",
-        description: "Returns the latest rates for one or more commodity symbols (e.g. gold, silver, crude oil). Rates may lag up to 10 minutes depending on plan. Use 'quote' to convert to a specific currency (Premium/Plus plans only).",
+        description: "Returns the latest rates for one or more commodity symbols (e.g. gold, silver, crude oil). Rates may lag up to 10 minutes depending on plan. Use 'quote' to convert to a specific currency (Premium/Plus plans only). Common names with a single match (e.g. GOLD) are auto-resolved to the real symbol and flagged in 'unresolved' with 'resolvedTo'. Set 'metadata' to false to omit the per-symbol unit/quote map.",
         inputSchema: {
             symbols: symbolsParam,
-            quote: z
-                .string()
-                .optional()
-                .describe("Target quote currency code (e.g. 'USD', 'EUR'). Premium/Plus plans only; omit to use each symbol's default currency."),
+            quote: quoteParam,
+            metadata: metadataParam,
         },
-    }, async ({ symbols, quote }) => {
+    }, async ({ symbols, quote, metadata }) => {
         try {
-            const data = await callCommodityApi("/rates/latest", { symbols, quote });
+            const data = await callCommodityApi("/rates/latest", {
+                symbols,
+                quote,
+                metadata: metadataFlag(metadata),
+            });
             return textResult(data);
         }
         catch (err) {
@@ -114,16 +136,19 @@ export function createServer() {
     });
     server.registerTool("get_gold_price", {
         title: "Get latest gold (XAU) price",
-        description: "Shortcut for the latest gold (XAU) rate without needing to pass a symbols list.",
+        description: "Shortcut for the latest gold (XAU) rate, with bid/ask, without needing to pass a symbols list. Use 'include' to add a per-gram, per-tola, or per-carat breakdown. Set 'metadata' to false to omit the unit/quote map.",
         inputSchema: {
-            quote: z
-                .string()
-                .optional()
-                .describe("Target quote currency code. Premium/Plus plans only."),
+            quote: quoteParam,
+            include: includeParam,
+            metadata: metadataParam,
         },
-    }, async ({ quote }) => {
+    }, async ({ quote, include, metadata }) => {
         try {
-            const data = await callCommodityApi("/rates/latest/xau", { quote });
+            const data = await callCommodityApi("/rates/latest/xau", {
+                quote,
+                include,
+                metadata: metadataFlag(metadata),
+            });
             return textResult(data);
         }
         catch (err) {
@@ -132,16 +157,19 @@ export function createServer() {
     });
     server.registerTool("get_silver_price", {
         title: "Get latest silver (XAG) price",
-        description: "Shortcut for the latest silver (XAG) rate without needing to pass a symbols list.",
+        description: "Shortcut for the latest silver (XAG) rate, with bid/ask, without needing to pass a symbols list. Use 'include' to add a per-gram, per-tola, or per-carat breakdown. Set 'metadata' to false to omit the unit/quote map.",
         inputSchema: {
-            quote: z
-                .string()
-                .optional()
-                .describe("Target quote currency code. Premium/Plus plans only."),
+            quote: quoteParam,
+            include: includeParam,
+            metadata: metadataParam,
         },
-    }, async ({ quote }) => {
+    }, async ({ quote, include, metadata }) => {
         try {
-            const data = await callCommodityApi("/rates/latest/xag", { quote });
+            const data = await callCommodityApi("/rates/latest/xag", {
+                quote,
+                include,
+                metadata: metadataFlag(metadata),
+            });
             return textResult(data);
         }
         catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commoditypriceapi/mcp",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Official MCP server for CommodityPriceAPI \u2014 real-time and historical commodity rates (gold, silver, oil, and 130+ more) as MCP tools for Claude, Cursor, Windsurf, and any MCP client.",
   "keywords": [
     "mcp",