Merge pull request #133 from defog-ai/directory-guidelines

Follow the plugin directory checklist for bundled files and the README

Author: rishsriv

.claude-plugin/marketplace.json

@@ -9,7 +9,7 @@
     {
       "name": "factiq",
       "source": "./",
-      "description": "Answer economic and financial data questions with real data from FactIQ — official statistics, market data, earnings-call transcripts, executive media appearances, central-bank speeches and minutes, and a curated business-news feed — return sourced answers, chart JSON, or report JSON."
+      "description": "Answer economic and financial data questions with real data from FactIQ — official statistics, market data, earnings-call transcripts, executive media appearances, central-bank speeches and minutes, a curated business-news feed, and satellite-derived data (nighttime lights, shipping and port activity, reservoir levels, crop fires and wildfires with mappable footprints, NO2/SO2/CO activity, smoke and dust aerosol, monsoon rainfall) — return sourced answers, chart JSON, or report JSON."
     }
   ]
 }

.claude-plugin/plugin.json

@@ -1,7 +1,7 @@
 {
   "name": "factiq",
   "description": "Answer economic and financial data questions with real data from FactIQ — official statistics, market data, earnings-call transcripts, executive media appearances, central-bank speeches and minutes, a curated business-news feed, and satellite-derived data (nighttime lights, shipping and port activity, reservoir levels, crop fires and wildfires with mappable footprints, NO2/SO2/CO activity, smoke and dust aerosol, monsoon rainfall) — return sourced answers, chart JSON, or report JSON.",
-  "version": "0.42.0",
+  "version": "0.43.0",
   "author": {
     "name": "FactIQ",
     "url": "https://www.factiq.com"

.codex-plugin/plugin.json

@@ -1,7 +1,7 @@
 {
   "name": "factiq",
   "description": "Answer economic and financial data questions with real FactIQ data — official data, markets, earnings calls, executive media appearances, central-bank documents, and satellite-derived signals including crop fires and wildfires — then return sourced answers, chart JSON, or report JSON.",
-  "version": "0.42.0",
+  "version": "0.43.0",
   "author": {
     "name": "FactIQ",
     "url": "https://www.factiq.com"

README.md

@@ -162,44 +162,32 @@ Then authorize with `/mcp`.
 ### Without a browser: scripts, CI, and headless agents
 
 Every FactIQ tool also works with a personal API key instead of the browser
-sign-in. Create the key at [factiq.com/settings/security](https://www.factiq.com/settings/security)
-and send it as a bearer token. The full reference, with a REST endpoint table
-and Python examples, is at
-[factiq.com/docs/api](https://www.factiq.com/docs/api).
-
-Call a REST endpoint:
-
-```bash
-curl https://api.factiq.com/tools/context \
-  -H "Authorization: Bearer $FACTIQ_API_KEY"
-```
-
-Call an MCP tool over plain HTTP (one JSON-RPC POST, no session handshake):
-
-```bash
-curl https://api.factiq.com/mcp \
-  -H "Authorization: Bearer $FACTIQ_API_KEY" \
-  -H "Content-Type: application/json" \
-  -H "Accept: application/json, text/event-stream" \
-  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call",
-       "params":{"name":"get_data_catalog","arguments":{}}}'
-```
-
-Register the MCP server with the key so a headless coding agent never opens a
-browser:
-
-```bash
-# Claude Code
-claude mcp add factiq https://api.factiq.com/mcp --transport http \
-  --header "Authorization: Bearer $FACTIQ_API_KEY"
-
-# Codex (reads the key from the environment variable at start-up)
-codex mcp add factiq --url https://api.factiq.com/mcp \
-  --bearer-token-env-var FACTIQ_API_KEY
-```
-
-Keep the key out of source control. Regenerating it on the settings page
-revokes the old one immediately.
+sign-in. Create the key at [factiq.com/settings/security](https://www.factiq.com/settings/security).
+The guide at [factiq.com/docs/api](https://www.factiq.com/docs/api) shows how
+to call the REST endpoints and the MCP server with the key, and how to register
+the server in Claude Code or Codex without a browser. Keep the key out of
+source control. Regenerating it on the settings page revokes the old one
+immediately.
+
+## What the plugin sends and runs
+
+- **One remote MCP server.** The plugin adds `https://api.factiq.com/mcp`
+  (see `.mcp.json`), which you sign in to with OAuth. Each tool call sends its
+  arguments (search terms, SQL statements, series IDs, tickers, regions) to
+  that server and returns FactIQ data. FactIQ records connector tool inputs
+  and outputs for reliability and support, as described in the
+  [privacy policy](https://www.factiq.com/privacy).
+- **One tool that sends a message.** `send_feedback` sends a short report,
+  written by the agent, to the FactIQ team when a FactIQ result looks wrong.
+  It changes no data. Every other tool only reads data.
+- **Local scripts with no network access.** The skill can run the Python
+  scripts in `scripts/` (`hs_codes.py`, `trade_sql.py`, `comext_sql.py`,
+  `series_math.py`). They read only their arguments, files you pass them, and
+  the bundled files in `scripts/data/`, and they print their result. They make
+  no network calls.
+- **Local outputs only.** Charts and reports are files written in your own
+  workspace. The plugin does not publish them anywhere.
+- The plugin has no hooks and runs nothing when it is installed.
 
 ## Try it
 

SETUP.md

@@ -46,20 +46,9 @@ installed yet, the user can open
 
 When no browser is available, the user registers the MCP server with an API
 key instead of signing in. Point them to
-[factiq.com/docs/api](https://www.factiq.com/docs/api) for the full guide. The
-short form:
-
-```bash
-# Claude Code
-claude mcp add factiq https://api.factiq.com/mcp --transport http \
-  --header "Authorization: Bearer $FACTIQ_API_KEY"
-
-# Codex
-codex mcp add factiq --url https://api.factiq.com/mcp \
-  --bearer-token-env-var FACTIQ_API_KEY
-```
-
-The key must come from the user's own environment. Do not read it from a file,
+[factiq.com/docs/api](https://www.factiq.com/docs/api), which has the
+commands for Claude Code and Codex. The user creates the key and sets it up
+themselves. Do not read a key from the user's environment or from a file,
 print it, or write it into a commit.
 
 ## Verify the connection

scripts/data/hs_names.json.gz

@@ -0,0 +1,101 @@
+{
+"2": {
+"01": "Animals; live",
+"02": "Meat and edible meat offal",
+"03": "Fish and crustaceans, molluscs and other aquatic invertebrates",
+"04": "Dairy produce; birds' eggs; natural honey; edible products of animal origin, not elsewhere specified or included",
+"05": "Animal originated products; not elsewhere specified or included",
+"06": "Trees and other plants, live; bulbs, roots and the like; cut flowers and ornamental foliage",
+"07": "Vegetables and certain roots and tubers; edible",
+"08": "Fruit and nuts, edible; peel of citrus fruit or melons",
+"09": "Coffee, tea, mate and spices",
+"10": "Cereals",
+"11": "Products of the milling industry; malt, starches, inulin, wheat gluten",
+"12": "Oil seeds and oleaginous fruits; miscellaneous grains, seeds and fruit, industrial or medicinal plants; straw and fodder",
+"13": "Lac; gums, resins and other vegetable saps and extracts",
+"14": "Vegetable plaiting materials; vegetable products not elsewhere specified or included",
+"15": "Animal, vegetable or microbial fats and oils and their cleavage products; prepared edible fats; animal or vegetable waxes",
+"16": "Meat, fish, crustaceans, molluscs or other aquatic invertebrates, or insects; preparations thereof",
+"17": "Sugars and sugar confectionery",
+"18": "Cocoa and cocoa preparations",
+"19": "Preparations of cereals, flour, starch or milk; pastrycooks' products",
+"20": "Preparations of vegetables, fruit, nuts or other parts of plants",
+"21": "Miscellaneous edible preparations",
+"22": "Beverages, spirits and vinegar",
+"23": "Food industries, residues and wastes thereof; prepared animal fodder",
+"24": "Tobacco and manufactured tobacco substitutes; products, whether or not containing nicotine, intended for inhalation without combustion; other nicotine containing products intended for the intake of nicotine into the human body",
+"25": "Salt; sulphur; earths, stone; plastering materials, lime and cement",
+"26": "Ores, slag and ash",
+"27": "Mineral fuels, mineral oils and products of their distillation; bituminous substances; mineral waxes",
+"28": "Inorganic chemicals; organic and inorganic compounds of precious metals; of rare earth metals, of radio-active elements and of isotopes",
+"29": "Organic chemicals",
+"30": "Pharmaceutical products",
+"31": "Fertilizers",
+"32": "Tanning or dyeing extracts; tannins and their derivatives; dyes, pigments and other colouring matter; paints, varnishes; putty, other mastics; inks",
+"33": "Essential oils and resinoids; perfumery, cosmetic or toilet preparations",
+"34": "Soap, organic surface-active agents; washing, lubricating, polishing or scouring preparations; artificial or prepared waxes, candles and similar articles, modelling pastes, dental waxes and dental preparations with a basis of plaster",
+"35": "Albuminoidal substances; modified starches; glues; enzymes",
+"36": "Explosives; pyrotechnic products; matches; pyrophoric alloys; certain combustible preparations",
+"37": "Photographic or cinematographic goods",
+"38": "Chemical products n.e.c.",
+"39": "Plastics and articles thereof",
+"40": "Rubber and articles thereof",
+"41": "Raw hides and skins (other than furskins) and leather",
+"42": "Articles of leather; saddlery and harness; travel goods, handbags and similar containers; articles of animal gut (other than silk-worm gut)",
+"43": "Furskins and artificial fur; manufactures thereof",
+"44": "Wood and articles of wood; wood charcoal",
+"45": "Cork and articles of cork",
+"46": "Manufactures of straw, esparto or other plaiting materials; basketware and wickerwork",
+"47": "Pulp of wood or other fibrous cellulosic material; recovered (waste and scrap) paper or paperboard",
+"48": "Paper and paperboard; articles of paper pulp, of paper or paperboard",
+"49": "Printed books, newspapers, pictures and other products of the printing industry; manuscripts, typescripts and plans",
+"50": "Silk",
+"51": "Wool, fine or coarse animal hair; horsehair yarn and woven fabric",
+"52": "Cotton",
+"53": "Vegetable textile fibres; paper yarn and woven fabrics of paper yarn",
+"54": "Man-made filaments; strip and the like of man-made textile materials",
+"55": "Man-made staple fibres",
+"56": "Wadding, felt and nonwovens, special yarns; twine, cordage, ropes and cables and articles thereof",
+"57": "Carpets and other textile floor coverings",
+"58": "Fabrics; special woven fabrics, tufted textile fabrics, lace, tapestries, trimmings, embroidery",
+"59": "Textile fabrics; impregnated, coated, covered or laminated; textile articles of a kind suitable for industrial use",
+"60": "Fabrics; knitted or crocheted",
+"61": "Apparel and clothing accessories; knitted or crocheted",
+"62": "Apparel and clothing accessories; not knitted or crocheted",
+"63": "Textiles, made up articles; sets; worn clothing and worn textile articles; rags",
+"64": "Footwear; gaiters and the like; parts of such articles",
+"65": "Headgear and parts thereof",
+"66": "Umbrellas, sun umbrellas, walking-sticks, seat sticks, whips, riding crops; and parts thereof",
+"67": "Feathers and down, prepared; and articles made of feather or of down; artificial flowers; articles of human hair",
+"68": "Stone, plaster, cement, asbestos, mica or similar materials; articles thereof",
+"69": "Ceramic products",
+"70": "Glass and glassware",
+"71": "Natural, cultured pearls; precious, semi-precious stones; precious metals, metals clad with precious metal, and articles thereof; imitation jewellery; coin",
+"72": "Iron and steel",
+"73": "Iron or steel articles",
+"74": "Copper and articles thereof",
+"75": "Nickel and articles thereof",
+"76": "Aluminium and articles thereof",
+"78": "Lead and articles thereof",
+"79": "Zinc and articles thereof",
+"80": "Tin; articles thereof",
+"81": "Metals; n.e.c., cermets and articles thereof",
+"82": "Tools, implements, cutlery, spoons and forks, of base metal; parts thereof, of base metal",
+"83": "Metal; miscellaneous products of base metal",
+"84": "Machinery and mechanical appliances, boilers, nuclear reactors; parts thereof",
+"85": "Electrical machinery and equipment and parts thereof; sound recorders and reproducers; television image and sound recorders and reproducers, parts and accessories of such articles",
+"86": "Railway, tramway locomotives, rolling-stock and parts thereof; railway or tramway track fixtures and fittings and parts thereof; mechanical (including electro-mechanical) traffic signalling equipment of all kinds",
+"87": "Vehicles; other than railway or tramway rolling stock, and parts and accessories thereof",
+"88": "Aircraft, spacecraft, and parts thereof",
+"89": "Ships, boats and floating structures",
+"90": "Optical, photographic, cinematographic, measuring, checking, medical or surgical instruments and apparatus; parts and accessories",
+"91": "Clocks and watches and parts thereof",
+"92": "Musical instruments; parts and accessories of such articles",
+"93": "Arms and ammunition; parts and accessories thereof",
+"94": "Furniture; bedding, mattresses, mattress supports, cushions and similar stuffed furnishings; lamps and lighting fittings, n.e.c.; illuminated signs, illuminated name-plates and the like; prefabricated buildings",
+"95": "Toys, games and sports requisites; parts and accessories thereof",
+"96": "Miscellaneous manufactured articles",
+"97": "Works of art; collectors' pieces and antiques",
+"99": "Commodities not specified according to kind"
+}
+}