@trustrails/mcp-server 1.0.0 → 1.0.1

package/README.md

@@ -2,7 +2,10 @@
 
 **Search UK electronics products** - compare prices, find deals, and discover products across multiple retailers.
 
-Built for the [Model Context Protocol (MCP)](https://modelcontextprotocol.io) 
+Built for the [Model Context Protocol (MCP)](https://modelcontextprotocol.io) - works with Claude Desktop, Claude Code, and other MCP-compatible AI assistants.
+
+[![npm version](https://badge.fury.io/js/%40trustrails%2Fmcp-server.svg)](https://www.npmjs.com/package/@trustrails/mcp-server)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ---
 
@@ -16,7 +19,7 @@ npm install -g @trustrails/mcp-server
 
 ### Configuration
 
-Add to your Claude Code config (`~/.config/claude/config.json`):
+**For Claude Code** (`~/.config/claude/config.json`):
 
 ```json
 {
@@ -24,15 +27,14 @@ Add to your Claude Code config (`~/.config/claude/config.json`):
     "trustrails": {
       "command": "trustrails-mcp",
       "env": {
-        "TRUSTRAILS_API_KEY": "mcp-public-2026",
-        "TRUSTRAILS_BASE_URL": "https://www.trustrails.app"
+        "TRUSTRAILS_API_KEY": "mcp-public-2026"
       }
     }
   }
 }
 ```
 
-**Or** for Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_config.json`):
+**For Claude Desktop** (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
 
 ```json
 {
@@ -63,10 +65,10 @@ That's it! Restart Claude and start searching.
 ```
 
 Claude will search across multiple UK retailers and show you:
-- Real-time prices
-- Stock availability
-- Product specs
-- Purchase links
+- Real-time prices & availability
+- Product specs & descriptions
+- Stock status
+- Direct purchase links
 
 ---
 
@@ -74,14 +76,16 @@ Claude will search across multiple UK retailers and show you:
 
 ### `search_products`
 
-Search UK electronics across multiple retailers.
+Search UK electronics across multiple retailers (AO, Boxed2Me, In Stock UK, Back to the Office).
 
 **Parameters:**
 - `query` (string) - Search term (e.g., "laptop", "USB-C charger")
-- `min_price` (number) - Minimum price in GBP (optional)
-- `max_price` (number) - Maximum price in GBP (optional)
-- `brand` (string) - Filter by brand (optional)
-- `category` (string) - Filter by category (optional)
+- `min_price` (number, optional) - Minimum price in GBP
+- `max_price` (number, optional) - Maximum price in GBP
+- `brand` (string, optional) - Filter by brand (e.g., "Sony", "HP", "Apple")
+- `category` (string, optional) - Filter by category (e.g., "Laptops", "Headphones")
+
+**Returns:** Up to 20 products with full details (title, price, specs, availability, purchase links)
 
 ### `get_product`
 
@@ -90,35 +94,20 @@ Get detailed information about a specific product by ID.
 **Parameters:**
 - `product_id` (string) - The product ID from search results
 
----
-
-## Supported Retailers
-
-Search across **26,000+ products** from:
-
-- **AO** - Major UK electronics retailer
-- **Boxed2Me** - Tech and electronics
-- **Instock** - Computing and office equipment
-- **Back to the Office** - Office tech and supplies
-
-*More retailers added regularly*
+**Returns:** Complete product information including specifications and retailer details
 
 ---
 
-## Rate Limits
-
-- **20 requests per hour** per IP address
-- Rate limit info included in response headers (`X-RateLimit-Remaining`, `X-RateLimit-Reset`)
-- Limits reset every hour
-
-Plenty for normal use - just prevents abuse.
+## Supported Retailers
 
----
+Search across **26,000+ electronics products** from:
 
-## Environment Variables
+- **AO** - Major UK electronics & appliances retailer
+- **Boxed2Me** - Computing & electronics specialist
+- **In Stock UK** - Tech and office equipment
+- **Back to the Office** - Office technology & supplies
 
-- `TRUSTRAILS_API_KEY` - API key (use `mcp-public-2026` for shared access)
-- `TRUSTRAILS_BASE_URL` - API endpoint (defaults to `https://www.trustrails.app`)
+*More retailers being added regularly*
 
 ---
 
@@ -144,33 +133,98 @@ Plenty for normal use - just prevents abuse.
 "Which retailers have the HP Envy x360 in stock right now?"
 ```
 
+**Deal finding:**
+```
+"What are the best laptop deals under £600 from any retailer?"
+```
+
+---
+
+## Rate Limits
+
+- **20 requests per hour** per IP address
+- Rate limit info included in response headers
+- Limits reset every hour
+- Plenty for normal shopping research - just prevents abuse
+
+---
+
+## Environment Variables
+
+- `TRUSTRAILS_API_KEY` - API key (use `mcp-public-2026` for shared public access)
+- `TRUSTRAILS_BASE_URL` - API endpoint (optional, defaults to `https://www.trustrails.app`)
+
 ---
 
 ## Why TrustRails?
 
-- ✅ **Real-time data** - Updated daily
+- ✅ **Real-time data** - Product feeds updated twice daily
 - ✅ **Multiple retailers** - Compare prices in one search
-- ✅ **Stock info** - See what's actually available
-- ✅ **Direct purchase links** - Buy immediately
-- ✅ **Zero setup** - Works out of the box with shared key
+- ✅ **Stock information** - See what's actually available to buy
+- ✅ **Direct purchase links** - Click through to buy immediately
+- ✅ **Zero setup** - Works out of the box with shared public key
+- ✅ **UK-focused** - Optimized for UK electronics shopping
+
+---
+
+## Troubleshooting
+
+**"Command not found: trustrails-mcp"**
+- Make sure you installed globally: `npm install -g @trustrails/mcp-server`
+- Check your global npm bin path is in $PATH: `npm bin -g`
+
+**"Rate limit exceeded"**
+- Wait an hour for limits to reset
+- Check `X-RateLimit-Reset` header for exact reset time
+- 20 requests/hour is plenty for normal usage
+
+**"No results found"**
+- Try broader search terms (e.g., "laptop" instead of specific model)
+- Check spelling of brand names
+- Try searching without filters first
+
+---
+
+## Development
+
+### Local Setup
+
+```bash
+# Clone the repo
+git clone https://github.com/your-username/trustrails-mcp-server
+cd trustrails-mcp-server
+
+# Install dependencies
+npm install
+
+# Run locally
+npm run dev
+```
+
+### Testing
+
+```bash
+# Run the MCP inspector to test tools
+npx @modelcontextprotocol/inspector npm run dev
+```
 
 ---
 
 ## Support & Links
 
-- **Website:** https://www.trustrails.app
-- **GitHub:** https://github.com/james-webdev/trustrails
-- **Issues:** https://github.com/james-webdev/trustrails/issues
-- **NPM:** https://www.npmjs.com/package/@trustrails/mcp-server
+- **Website:** [trustrails.app](https://www.trustrails.app)
+- **Issues:** [GitHub Issues](https://github.com/your-username/trustrails-mcp-server/issues)
+- **NPM:** [@trustrails/mcp-server](https://www.npmjs.com/package/@trustrails/mcp-server)
+- **MCP Registry:** [modelcontextprotocol.io/servers](https://modelcontextprotocol.io/servers)
 
 ---
 
 ## License
 
-MIT
+MIT © TrustRails
 
 ---
 
 ## About MCP
 
-This server implements the [Model Context Protocol](https://modelcontextprotocol.io), allowing Claude to search products directly. Learn more about building MCP servers at [modelcontextprotocol.io](https://modelcontextprotocol.io).
+This server implements the [Model Context Protocol](https://modelcontextprotocol.io), a standard for connecting AI assistants to external tools and data sources. Learn more about building MCP servers at [modelcontextprotocol.io](https://modelcontextprotocol.io).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trustrails/mcp-server",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "MCP server for searching UK electronics products across multiple retailers",
   "type": "module",
   "bin": {
@@ -29,8 +29,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/james-webdev/trustrails.git",
-    "directory": "packages/mcp-server"
+    "url": "https://github.com/james-webdev/trustrails-mcp-server.git"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.25.1"