mcp-crypto-price 3.5.12 → 4.0.0

package/README.md

@@ -17,6 +17,10 @@ A Model Context Protocol (MCP) server that provides comprehensive cryptocurrency
 - **BREAKING**: CoinCap v2 API removed. Now uses v3 API exclusively. A `COINCAP_API_KEY` is required (free tier available at [pro.coincap.io/dashboard](https://pro.coincap.io/dashboard))
 - Streamable HTTP transport added (while keeping STDIO compatibility)
 - Smithery CLI scripts to build and run the HTTP server
+- **6 new tools**: `assets.search`, `market.global`, `assets.compare`, `analysis.candlestick`, `price.convert`, `assets.info`
+- **Dot-notation tool naming**: All tools organized into a navigable tree (`price.*`, `market.*`, `assets.*`, `analysis.*`)
+- **Output schemas**: All tools now declare `outputSchema` with `structuredContent` for type-safe responses
+- **MCP best practices**: `isError` flag on validation errors, server description, and `asset://{symbol}` resource template
 
 ## Usage
 
@@ -58,14 +62,15 @@ If your MCP client requires launching via `cmd.exe` on Windows:
 ### Development scripts
 
 ```bash
-npm run build         # Compile TypeScript → dist/
-npm run format        # Format source files with Prettier
-npm run lint          # Check for lint errors (ESLint + typescript-eslint)
-npm run lint:fix      # Auto-fix lint errors
-npm run types:check   # TypeScript type-check without emitting files
-npm test              # Run all tests
-npm run test:coverage # Run tests with coverage report
-npm run inspector     # Open MCP inspector for interactive debugging
+pnpm dev          # Development (HTTP server with hot reload via Smithery CLI)
+pnpm build         # Compile TypeScript → dist/
+pnpm format        # Format source files with Prettier
+pnpm lint          # Check for lint errors (ESLint + typescript-eslint)
+pnpm lint:fix      # Auto-fix lint errors
+pnpm types:check   # TypeScript type-check without emitting files
+pnpm test          # Run all tests with Vitest
+pnpm test:coverage # Run tests with coverage report (Vitest)
+pnpm inspector     # Open MCP inspector for interactive debugging
 ```
 
 ### Run as Streamable HTTP server
@@ -75,27 +80,27 @@ You can run the server over HTTP for environments that support MCP over HTTP str
 - Dev server (recommended during development):
 
 ```bash
-npm run dev
+pnpm dev
 ```
 
 - Build and run the HTTP server:
 
 ```bash
 # Build (outputs to dist/)
-npm run build
+pnpm build
 
 # Start the HTTP server
-npm run start:http
+pnpm start:http
 ```
 
 - Build and run the STDIO server:
 
 ```bash
 # Build (outputs to dist/)
-npm run build
+pnpm build
 
 # Start the STDIO server
-npm run start:stdio
+pnpm start:stdio
 ```
 
 The server listens on port 3000 by default (override with `PORT`). For clients that connect over HTTP (e.g. Smithery, Claude.ai), pass your API key as a query parameter:
@@ -123,7 +128,7 @@ Without a valid API key, all tools will return an error with instructions on how
 
 ## Note for Smithery CLI users
 
-This MCP server works directly via `npx` (configs above) and does not require Smithery.
+This MCP server works directly via `pnpm dlx` (configs above) and does not require Smithery.
 
 If you do use the Smithery CLI, authenticate with `smithery auth login` or by setting `SMITHERY_API_KEY` in your environment. Recent versions of the Smithery CLI do not support passing API keys via `--key` (or older `--profile` patterns).
 
@@ -131,7 +136,7 @@ Launch Claude Desktop to start using the crypto analysis tools.
 
 ## Tools
 
-#### get-crypto-price
+#### price.get
 
 Gets current price and 24h stats for any cryptocurrency, including:
 - Current price in USD
@@ -140,7 +145,14 @@ Gets current price and 24h stats for any cryptocurrency, including:
 - Market cap
 - Market rank
 
-#### get-market-analysis
+#### price.convert
+
+Converts a cryptocurrency amount into any fiat currency:
+- Uses real-time price data and USD-based exchange rates
+- Parameters: `symbol` (e.g. `BTC`), `amount` (default 1), `currency` (default `usd`)
+- Example: 2.5 BTC in EUR
+
+#### market.analysis
 
 Provides detailed market analysis including:
 - Top 5 exchanges by volume
@@ -148,16 +160,31 @@ Provides detailed market analysis including:
 - Volume distribution analysis
 - VWAP (Volume Weighted Average Price)
 
-#### get-historical-analysis
+#### market.global
 
-Analyzes historical price data with:
-- Customizable time intervals (5min to 1 day)
-- Support for up to 30 days of historical data
-- Price trend analysis
-- Volatility metrics
-- High/low price ranges
+Provides an overview of the entire cryptocurrency market:
+- Total market capitalization across all assets
+- 24-hour trading volume
+- Number of active cryptocurrencies
+- Bitcoin dominance percentage
+- Top gainers and losers
+
+#### market.rates
+
+Returns USD-based conversion rates for fiat currencies and cryptocurrencies:
+- All fiat currency rates (USD base)
+- Top 10 cryptocurrency rates
+- Optional `slug` parameter (e.g. `euro`, `bitcoin`) for a single rate lookup
+
+#### market.exchanges
 
-#### get-top-assets
+Lists top cryptocurrency exchanges ranked by 24h volume:
+- Exchange name, rank, and 24h volume in USD
+- Number of trading pairs and market share percentage
+- Optional `exchangeId` parameter (e.g. `binance`) for single exchange details
+- Optional `limit` parameter (1–50, default 10)
+
+#### assets.top
 
 Lists top cryptocurrencies ranked by market cap, including:
 - Current price in USD
@@ -165,7 +192,38 @@ Lists top cryptocurrencies ranked by market cap, including:
 - Market cap and rank
 - Configurable result count (1–50, default 10)
 
-#### get-technical-analysis
+#### assets.search
+
+Searches for cryptocurrencies by name or symbol with fuzzy matching:
+- Returns matching assets with symbol, name, price, and rank
+- Configurable result count (1–50, default 10)
+- Example: search "bit" returns Bitcoin, Bitcoin Cash, BitTorrent, etc.
+
+#### assets.info
+
+Returns detailed metadata for a single cryptocurrency:
+- ID, rank, symbol, and name
+- Price, 24h change, market cap, and volume
+- Circulating supply and max supply
+- VWAP (24h)
+
+#### assets.compare
+
+Compares 2–5 cryptocurrencies side by side:
+- Price, 24h change, market cap, volume, and rank for each asset
+- Comma-separated symbols (e.g. `BTC,ETH,SOL`)
+- Highlights best performer by 24h change
+
+#### analysis.historical
+
+Analyzes historical price data with:
+- Customizable time intervals (5min to 1 day)
+- Support for up to 30 days of historical data
+- Price trend analysis
+- Volatility metrics
+- High/low price ranges
+
+#### analysis.technical
 
 Returns the latest technical indicators for any cryptocurrency:
 - SMA (Simple Moving Average) with period
@@ -174,20 +232,33 @@ Returns the latest technical indicators for any cryptocurrency:
 - MACD with signal line, histogram, and Bullish/Bearish label
 - VWAP (Volume Weighted Average Price, 24h)
 
-#### get-rates
+#### analysis.candlestick
 
-Returns USD-based conversion rates for fiat currencies and cryptocurrencies:
-- All fiat currency rates (USD base)
-- Top 10 cryptocurrency rates
-- Optional `slug` parameter (e.g. `euro`, `bitcoin`) for a single rate lookup
+Retrieves OHLCV candlestick data from a specific exchange:
+- Open, high, low, close, and volume for each candle
+- Configurable exchange (e.g. `binance`), quote currency (e.g. `usd`), and interval (`5m`, `15m`, `1h`, `6h`, `1d`)
+- Supports 1–30 days of historical candles
 
-#### get-exchanges
+## Resources
 
-Lists top cryptocurrency exchanges ranked by 24h volume:
-- Exchange name, rank, and 24h volume in USD
-- Number of trading pairs and market share percentage
-- Optional `exchangeId` parameter (e.g. `binance`) for single exchange details
-- Optional `limit` parameter (1–50, default 10)
+The server exposes the following MCP resources:
+
+- **`info://server`** — Server name and version metadata
+- **`asset://{symbol}`** — Cryptocurrency asset information by symbol (e.g. `asset://BTC`), returned as JSON
+
+## Prompts
+
+The server exposes the following MCP prompts that clients can invoke:
+
+| Prompt | Args | Description |
+|--------|------|-------------|
+| `analyze-crypto` | `symbol` | Comprehensive analysis: price, market, historical trends |
+| `compare-cryptocurrencies` | `symbols` | Compare 2-5 cryptos side-by-side |
+| `market-overview` | — | Global market snapshot: metrics, top assets, top exchanges |
+| `crypto-conversion` | `symbol`, `amount?`, `currency?` | Convert crypto amount to fiat |
+| `exchange-analysis` | `symbol` | Exchange landscape analysis for a crypto |
+| `technical-analysis` | `symbol` | Full technical analysis: indicators, candles, trends |
+| `crypto-screener` | `query` | Search and screen cryptos for opportunities |
 
 ## Sample Prompts
 
@@ -199,10 +270,24 @@ Lists top cryptocurrency exchanges ranked by 24h volume:
 - "What are the technical indicators for ETH right now?"
 - "What's the current EUR to USD exchange rate?"
 - "Which crypto exchanges have the highest 24h volume?"
-
-## Project Inspiration
-
-This project was inspired by Alex Andru's [coincap-mcp](https://github.com/QuantGeekDev/coincap-mcp) project.
+- "Search for cryptocurrencies matching 'sol'"
+- "Give me a global overview of the crypto market"
+- "Compare BTC, ETH, and SOL side by side"
+- "Show me 1-hour candlestick data for BTC on Binance over the last 3 days"
+- "Convert 2.5 BTC to EUR"
+- "Get detailed info about the Ethereum asset"
+- "Generate a comprehensive analysis of a cryptocurrency covering price, market, and historical trends"
+- "Find all cryptocurrencies with 'bit' in their name and show me their current prices"
+- "What's the market cap ranking and circulating supply of Cardano?"
+- "Compare the top 3 stablecoins and show which has the highest volume"
+- "Show me how Bitcoin has performed over the past 30 days with daily candles"
+- "Convert 100 SOL to GBP and show the exchange rate"
+- "Give me a full market snapshot: global metrics, top gainers, and BTC dominance"
+- "What are the best and worst performing cryptos in the last 24 hours?"
+- "Show me 15-minute candlestick data for ETH on Coinbase over the last 2 days"
+- "Compare DeFi tokens: UNI, AAVE, COMP, and MKR"
+- "What's the VWAP and max supply of Bitcoin?"
+- "Search for layer-2 tokens and compare the top results"
 
 ## License
 

package/dist/homepage.js

@@ -290,7 +290,7 @@ export function renderHomepage() {
             </div>
             <div class="metric">
               <strong>CLI example</strong>
-              <code>npx @smithery/cli install mcp-crypto-price --client claude</code>
+              <code>pnpm dlx @smithery/cli install mcp-crypto-price --client claude</code>
             </div>
             <div class="metric">
               <strong>Remote endpoint</strong>