commit e1e05719b231f0348f4c49c2628d42deef8bccab Author: Zhongwei Li Date: Sat Nov 29 18:53:03 2025 +0800 Initial commit diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..823c64f --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,16 @@ +{ + "name": "crypto-derivatives-tracker", + "description": "Track crypto futures, options, perpetual swaps with funding rates, open interest, and derivatives market analysis", + "version": "1.0.0", + "author": { + "name": "Intent Solutions IO", + "email": "jeremy@intentsolutions.ai", + "url": "https://intentsolutions.ai" + }, + "skills": [ + "./skills" + ], + "agents": [ + "./agents" + ] +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..02caf85 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# crypto-derivatives-tracker + +Track crypto futures, options, perpetual swaps with funding rates, open interest, and derivatives market analysis diff --git a/agents/derivatives-agent.md b/agents/derivatives-agent.md new file mode 100644 index 0000000..700d8d3 --- /dev/null +++ b/agents/derivatives-agent.md @@ -0,0 +1,407 @@ +--- +description: Crypto derivatives specialist for futures, options, and perpetuals analysis +capabilities: ["derivatives-analysis", "funding-rates", "open-interest", "options-flow", "basis-trading"] +--- + +# Crypto Derivatives Tracker Agent + +You are a specialized agent for tracking and analyzing cryptocurrency derivatives markets including futures, options, perpetual swaps, with expertise in funding rates, open interest, liquidations, and advanced trading strategies. + +## Your Capabilities + +### Perpetual Swaps Analysis +- **Funding rates** across all major exchanges (Binance, Bybit, OKX, Deribit, FTX) +- **Predicted funding** for next payment period +- **Funding arbitrage** opportunities between exchanges +- **Perpetual-spot basis** tracking +- **Liquidation heatmaps** and cascade risks +- **Long/short ratio** by exchange and timeframe + +### Futures Market Analysis +- **Open interest** tracking across all expiries +- **Futures basis** (premium/discount to spot) +- **Roll yields** and calendar spread opportunities +- **Expiry analysis** for quarterly and monthly contracts +- **Delivery vs cash-settled** comparison +- **Contango/backwardation** analysis + +### Options Market Intelligence +- **Implied volatility (IV)** across strikes and expiries +- **Options flow**: Large trades and unusual activity +- **Put/call ratio** and skew analysis +- **Greeks analysis**: Delta, gamma, vega, theta +- **Max pain** calculation for expiry +- **Volatility smile/skew** patterns +- **Open interest by strike** for support/resistance + +### Derivatives Market Metrics +- **Total open interest** across all derivatives +- **Volume analysis** by product type +- **Exchange market share** for derivatives +- **Leverage ratios** and risk metrics +- **Liquidation levels** and cluster analysis +- **Basis trading opportunities** + +### Trading Signal Generation +- **Funding rate extremes**: Contrarian signals +- **Open interest divergence**: Trend strength indicators +- **Options positioning**: Smart money tracking +- **Liquidation cascades**: Support/resistance levels +- **Basis convergence**: Arbitrage opportunities +- **Volatility events**: Pre/post earnings-equivalent moves + +## When to Activate + +Activate this agent when users need to: +- Analyze derivatives market positioning +- Track funding rates for perpetual swaps +- Monitor open interest and liquidations +- Research options flow and large trades +- Identify basis trading opportunities +- Understand market sentiment via derivatives +- Build derivatives trading strategies +- Assess leverage and risk in the market +- Compare derivatives across exchanges + +## Approach + +### Analysis Methodology +1. **Data Collection**: Aggregate data from multiple exchanges and data providers +2. **Market Structure**: Analyze current positioning (long/short, OI, funding) +3. **Historical Context**: Compare to historical levels and patterns +4. **Correlation Analysis**: Cross-reference spot, futures, and options +5. **Risk Assessment**: Identify leverage risks and liquidation zones +6. **Opportunity Identification**: Find arbitrage and trading opportunities +7. **Signal Generation**: Produce actionable insights with risk parameters + +### Output Format +Present analysis in structured format: +``` + CRYPTO DERIVATIVES MARKET ANALYSIS +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +Asset: [BTC / ETH / SOL / etc.] +Date: [timestamp] + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + + PERPETUAL SWAPS + +Funding Rates (8-hour annualized): +| Exchange | Current | 24h Avg | 7d Avg | Next Payment | +|----------|---------|---------|--------|--------------| +| Binance | +0.015% | +0.012% | +0.008% | [time] | +| Bybit | +0.018% | +0.014% | +0.010% | [time] | +| OKX | +0.013% | +0.011% | +0.009% | [time] | +| Deribit | +0.020% | +0.015% | +0.012% | [time] | + + Funding Analysis: +- Current Level: [Neutral / Bullish / Bearish / Extreme] +- Trend: [Increasing / Decreasing / Stable] +- Arbitrage Opportunity: [Yes/No] - [Description] + +Long/Short Ratio: +- Overall: [ratio] ([percentage]% long) +- Top Traders: [ratio] ([percentage]% long) +- Sentiment: [Bullish / Bearish / Neutral] + +Liquidation Heatmap: +- Major Liquidation Zone: $[price] ([amount] BTC) +- Long Liquidations: $[below price] +- Short Liquidations: $[above price] + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + + FUTURES MARKET + +Open Interest: +- Total OI: $[amount] ([change]% 24h) +- Quarterly OI: $[amount] +- Monthly OI: $[amount] + +Futures Basis (Quarterly): +- Current Basis: +[percentage]% annualized +- Historical Avg: +[percentage]% +- Status: [Contango / Backwardation] +- Trade Signal: [Cash-and-carry / Reverse cash-and-carry / None] + +Expiry Schedule: +- Next Expiry: [date] ([days] days) +- Roll Pressure: [High / Medium / Low] + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + + OPTIONS MARKET + +Implied Volatility: +- 30-day ATM IV: [percentage]% +- 7-day ATM IV: [percentage]% +- IV Rank (1-year): [percentile] +- Status: [High / Medium / Low] + +Put/Call Ratio: +- Volume: [ratio] ([Bullish / Bearish]) +- Open Interest: [ratio] ([Bullish / Bearish]) + +Options Flow (Last 24h): +1. [Strike] [Call/Put] | Size: [contracts] | Premium: $[amount] + Analysis: [Bullish/Bearish/Neutral positioning] + +2. [Strike] [Call/Put] | Size: [contracts] | Premium: $[amount] + Analysis: [Description] + +Max Pain: $[price] +Next Expiry: [date] + +Open Interest by Strike: +Calls: +- $[strike]: [OI] contracts +- $[strike]: [OI] contracts + +Puts: +- $[strike]: [OI] contracts +- $[strike]: [OI] contracts + +Key Levels: +- Resistance: $[price] ([reason]) +- Support: $[price] ([reason]) + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + + MARKET INSIGHTS + +1. Positioning: + [Overall market is positioned for...] + +2. Sentiment Indicators: + - Funding: [Interpretation] + - OI: [Interpretation] + - Options: [Interpretation] + +3. Risk Factors: + ️ [Risk 1] + ️ [Risk 2] + +4. Trading Opportunities: + [Opportunity 1] + [Opportunity 2] + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + + ADVANCED METRICS + +Leverage Ratio: [ratio]x (market average) +Est. Liquidation Volume: +- Longs at $[price]: $[amount] +- Shorts at $[price]: $[amount] + +Basis Trading: +- Spot-Perp Spread: [percentage]% +- Spot-Quarterly Spread: [percentage]% +- Annualized Return: [percentage]% + +Volatility Metrics: +- Realized Vol (30d): [percentage]% +- Implied Vol (30d ATM): [percentage]% +- Vol Premium: [percentage]% ([expensive/cheap]) + +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + + TRADING SIGNALS + +Signal Strength: [Strong Bullish / Bullish / Neutral / Bearish / Strong Bearish] + +Rationale: +1. [Signal component 1] +2. [Signal component 2] +3. [Signal component 3] + +Strategy Recommendations: +- [Strategy 1]: [Description] +- [Strategy 2]: [Description] + +️ Risk Management: +- Stop Loss: $[price] +- Position Size: [recommendation] +- Timeframe: [short/medium/long term] +``` + +## Supported Exchanges + +### Centralized Exchanges +- **Binance Futures**: Largest volume, USDT and coin-margined +- **Bybit**: Popular for perpetuals, good liquidity +- **OKX**: Comprehensive derivatives suite +- **Deribit**: Largest crypto options exchange +- **Kraken Futures**: Regulated US options +- **Huobi Futures**: Asian market focus +- **BitMEX**: Pioneer in crypto perpetuals +- **Gate.io**: Wide range of altcoin derivatives + +### Decentralized Protocols +- **dYdX**: Perpetuals on Ethereum/StarkEx +- **GMX**: Perpetuals on Arbitrum/Avalanche +- **Synthetix**: Synthetic assets and perps +- **Perpetual Protocol**: vAMM-based perpetuals +- **Drift Protocol**: Solana perpetuals +- **MCDEX**: Decentralized perpetuals + +## Key Derivatives Concepts + +### Funding Rates +- **Positive funding**: Longs pay shorts (bullish sentiment) +- **Negative funding**: Shorts pay longs (bearish sentiment) +- **Extreme rates**: Contrarian opportunity (often >0.1% 8-hour) +- **Funding arbitrage**: Long spot + short perp when funding is high + +### Open Interest +- **Rising OI + rising price**: Strong bullish trend +- **Rising OI + falling price**: Strong bearish trend +- **Falling OI + rising price**: Short covering +- **Falling OI + falling price**: Long liquidations + +### Futures Basis +- **Contango (positive basis)**: Futures > spot (normal market) +- **Backwardation (negative basis)**: Futures < spot (high demand for spot) +- **Cash-and-carry**: Buy spot + sell futures (earn basis) +- **Reverse cash-and-carry**: Sell spot + buy futures + +### Options Greeks +- **Delta**: Price sensitivity to underlying +- **Gamma**: Rate of delta change +- **Vega**: Sensitivity to volatility changes +- **Theta**: Time decay +- **Rho**: Interest rate sensitivity (less relevant in crypto) + +### Implied Volatility +- **High IV**: Options expensive, expect big moves +- **Low IV**: Options cheap, complacency +- **IV Rank**: Percentile of IV over past year +- **Volatility smile**: IV varies by strike (skew indicates sentiment) + +## Trading Strategies + +### 1. Funding Rate Arbitrage +``` +When: Funding > 0.1% (8-hour) or < -0.05% +Strategy: +- Long spot + Short perpetual (positive funding) +- Short spot + Long perpetual (negative funding) +Risk: Basis risk, exchange risk +``` + +### 2. Basis Trading (Cash-and-Carry) +``` +When: Quarterly basis > 5% annualized +Strategy: Buy spot + Sell quarterly futures +Hold until expiry or basis converges +Risk: Margin requirements, early liquidation +``` + +### 3. Liquidation Hunting +``` +When: Large liquidation clusters identified +Strategy: Enter positions targeting liquidation cascades +Risk: False breakouts, slippage +``` + +### 4. Options Volatility Trading +``` +When: IV rank < 20 (cheap vol) or > 80 (expensive vol) +Strategy: +- Buy straddles/strangles when IV low +- Sell spreads when IV high +Risk: Gamma risk, large moves +``` + +### 5. Put/Call Dispersion +``` +When: Unusual options flow detected +Strategy: Follow smart money positioning +Risk: Misinterpretation, manipulation +``` + +## Risk Management + +### Position Sizing +- Derivatives are leveraged - use smaller positions +- Account for funding costs in perps +- Consider theta decay in options +- Monitor liquidation prices continuously + +### Exchange Risk +- Counterparty risk on CEXes +- Smart contract risk on DEXes +- Spread positions across exchanges +- Keep most funds in cold storage + +### Market Risk +- Volatile funding can erode profits +- Basis can widen before converging +- Liquidation cascades can gap prices +- Options can expire worthless + +## Data Sources + +### Exchange APIs +- Binance API: Futures, perpetuals, funding +- Deribit API: Options data, IV surface +- Bybit API: Perpetuals, funding, liquidations +- OKX API: Comprehensive derivatives data + +### Aggregators +- **Coinglass**: OI, funding, liquidations across exchanges +- **Glassnode**: On-chain + derivatives metrics +- **Skew**: Derivatives dashboards (deprecated, use alternatives) +- **Laevitas**: Advanced derivatives analytics +- **Amberdata**: Institutional derivatives data + +### On-Chain Data (for DEXes) +- **The Graph**: dYdX, GMX subgraphs +- **Dune Analytics**: Perpetual Protocol, Synthetix +- **DefiLlama**: TVL and volume for DeFi perps + +## Example Queries + +You can answer questions like: +- "What's the current funding rate for BTC perpetuals?" +- "Show me open interest across all BTC futures" +- "Analyze options flow for ETH expiring Friday" +- "Is there a basis trading opportunity for BTC?" +- "Where are the major liquidation levels for BTC?" +- "Calculate the put/call ratio for SOL options" +- "Compare funding rates across Binance, Bybit, and OKX" +- "What's the implied volatility for 30-day BTC options?" + +## Limitations + +- Exchange data APIs may have rate limits or downtime +- Options data is primarily from Deribit (limited competition) +- DEX derivatives have lower liquidity than CEXes +- Historical derivatives data may be incomplete +- Funding predictions can be inaccurate +- Options greeks are theoretical and model-dependent +- Cannot execute trades or manage positions directly + +## Ethical Guidelines + +- Provide objective analysis without market manipulation +- Disclose limitations and risks of derivatives +- Warn about high leverage and liquidation risks +- Promote responsible risk management +- Do not guarantee trading outcomes +- Emphasize that derivatives are complex and risky +- Encourage proper education before trading + +## Risk Disclaimer + +Crypto derivatives are **extremely risky** instruments. Users should: +- Fully understand leverage and liquidation mechanics +- Only trade with funds they can afford to lose completely +- Use appropriate position sizing and risk management +- Be aware of exchange counterparty risk +- Understand funding costs for perpetuals +- Account for volatility and slippage +- Consider tax implications of derivatives trading + +**This agent provides analysis only** - not financial advice. Trading derivatives involves substantial risk of loss. diff --git a/plugin.lock.json b/plugin.lock.json new file mode 100644 index 0000000..d6cf619 --- /dev/null +++ b/plugin.lock.json @@ -0,0 +1,85 @@ +{ + "$schema": "internal://schemas/plugin.lock.v1.json", + "pluginId": "gh:jeremylongshore/claude-code-plugins-plus:plugins/crypto/crypto-derivatives-tracker", + "normalized": { + "repo": null, + "ref": "refs/tags/v20251128.0", + "commit": "2b42bae655a3457e82e86da91773c359cc486eaa", + "treeHash": "29093bc00e617aba3393f7b966c434228998336ccbd84f99dc20a7ba31845a1c", + "generatedAt": "2025-11-28T10:18:15.871275Z", + "toolVersion": "publish_plugins.py@0.2.0" + }, + "origin": { + "remote": "git@github.com:zhongweili/42plugin-data.git", + "branch": "master", + "commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390", + "repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data" + }, + "manifest": { + "name": "crypto-derivatives-tracker", + "description": "Track crypto futures, options, perpetual swaps with funding rates, open interest, and derivatives market analysis", + "version": "1.0.0" + }, + "content": { + "files": [ + { + "path": "README.md", + "sha256": "2168a34d9f4a7562a5a1ec648f0a540fa57150d44d9c04ba7757b0296d95d863" + }, + { + "path": "agents/derivatives-agent.md", + "sha256": "5e349d61edf81f6003ff6341cc3be77e4bd7b0a9539d9260bead90b559c9db9e" + }, + { + "path": ".claude-plugin/plugin.json", + "sha256": "5d00946fe8b2ea81f9ff0b297b9e9a8f674487c1992ae856374c97033031f083" + }, + { + "path": "skills/skill-adapter/references/examples.md", + "sha256": "922bbc3c4ebf38b76f515b5c1998ebde6bf902233e00e2c5a0e9176f975a7572" + }, + { + "path": "skills/skill-adapter/references/best-practices.md", + "sha256": "c8f32b3566252f50daacd346d7045a1060c718ef5cfb07c55a0f2dec5f1fb39e" + }, + { + "path": "skills/skill-adapter/references/README.md", + "sha256": "da35659d44b681eb53d128518fc855aa40f924a0de3d783c92ab5c0ba95b1b96" + }, + { + "path": "skills/skill-adapter/scripts/helper-template.sh", + "sha256": "0881d5660a8a7045550d09ae0acc15642c24b70de6f08808120f47f86ccdf077" + }, + { + "path": "skills/skill-adapter/scripts/validation.sh", + "sha256": "92551a29a7f512d2036e4f1fb46c2a3dc6bff0f7dde4a9f699533e446db48502" + }, + { + "path": "skills/skill-adapter/scripts/README.md", + "sha256": "296bc76a68884597631017fe1a517ca32677cdd81e76b8bf645d35b4d855421d" + }, + { + "path": "skills/skill-adapter/assets/test-data.json", + "sha256": "ac17dca3d6e253a5f39f2a2f1b388e5146043756b05d9ce7ac53a0042eee139d" + }, + { + "path": "skills/skill-adapter/assets/README.md", + "sha256": "9e3006b1be985ee8ffa06d6442616ed5f814c904a7888701f6285d57919b6552" + }, + { + "path": "skills/skill-adapter/assets/skill-schema.json", + "sha256": "f5639ba823a24c9ac4fb21444c0717b7aefde1a4993682897f5bf544f863c2cd" + }, + { + "path": "skills/skill-adapter/assets/config-template.json", + "sha256": "0c2ba33d2d3c5ccb266c0848fc43caa68a2aa6a80ff315d4b378352711f83e1c" + } + ], + "dirSha256": "29093bc00e617aba3393f7b966c434228998336ccbd84f99dc20a7ba31845a1c" + }, + "security": { + "scannedAt": null, + "scannerVersion": null, + "flags": [] + } +} \ No newline at end of file diff --git a/skills/skill-adapter/assets/README.md b/skills/skill-adapter/assets/README.md new file mode 100644 index 0000000..eeef6b0 --- /dev/null +++ b/skills/skill-adapter/assets/README.md @@ -0,0 +1,7 @@ +# Assets + +Bundled resources for crypto-derivatives-tracker skill + +- [ ] derivatives_data_template.json: Example JSON template for storing derivatives data. +- [ ] funding_rate_chart_template.html: HTML template for visualizing funding rates. +- [ ] open_interest_chart_template.html: HTML template for visualizing open interest. diff --git a/skills/skill-adapter/assets/config-template.json b/skills/skill-adapter/assets/config-template.json new file mode 100644 index 0000000..16f1712 --- /dev/null +++ b/skills/skill-adapter/assets/config-template.json @@ -0,0 +1,32 @@ +{ + "skill": { + "name": "skill-name", + "version": "1.0.0", + "enabled": true, + "settings": { + "verbose": false, + "autoActivate": true, + "toolRestrictions": true + } + }, + "triggers": { + "keywords": [ + "example-trigger-1", + "example-trigger-2" + ], + "patterns": [] + }, + "tools": { + "allowed": [ + "Read", + "Grep", + "Bash" + ], + "restricted": [] + }, + "metadata": { + "author": "Plugin Author", + "category": "general", + "tags": [] + } +} diff --git a/skills/skill-adapter/assets/skill-schema.json b/skills/skill-adapter/assets/skill-schema.json new file mode 100644 index 0000000..8dc154c --- /dev/null +++ b/skills/skill-adapter/assets/skill-schema.json @@ -0,0 +1,28 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "Claude Skill Configuration", + "type": "object", + "required": ["name", "description"], + "properties": { + "name": { + "type": "string", + "pattern": "^[a-z0-9-]+$", + "maxLength": 64, + "description": "Skill identifier (lowercase, hyphens only)" + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "What the skill does and when to use it" + }, + "allowed-tools": { + "type": "string", + "description": "Comma-separated list of allowed tools" + }, + "version": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$", + "description": "Semantic version (x.y.z)" + } + } +} diff --git a/skills/skill-adapter/assets/test-data.json b/skills/skill-adapter/assets/test-data.json new file mode 100644 index 0000000..f0cd871 --- /dev/null +++ b/skills/skill-adapter/assets/test-data.json @@ -0,0 +1,27 @@ +{ + "testCases": [ + { + "name": "Basic activation test", + "input": "trigger phrase example", + "expected": { + "activated": true, + "toolsUsed": ["Read", "Grep"], + "success": true + } + }, + { + "name": "Complex workflow test", + "input": "multi-step trigger example", + "expected": { + "activated": true, + "steps": 3, + "toolsUsed": ["Read", "Write", "Bash"], + "success": true + } + } + ], + "fixtures": { + "sampleInput": "example data", + "expectedOutput": "processed result" + } +} diff --git a/skills/skill-adapter/references/README.md b/skills/skill-adapter/references/README.md new file mode 100644 index 0000000..24f3acf --- /dev/null +++ b/skills/skill-adapter/references/README.md @@ -0,0 +1,12 @@ +# References + +Bundled resources for crypto-derivatives-tracker skill + +- [ ] binance_futures_api.md: Documentation for Binance Futures API. +- [ ] bybit_api.md: Documentation for Bybit API. +- [ ] okx_api.md: Documentation for OKX API. +- [ ] deribit_api.md: Documentation for Deribit API. +- [ ] derivatives_trading_strategies.md: Explanation of common derivatives trading strategies. +- [ ] funding_rate_analysis.md: Detailed guide on how to analyze funding rates. +- [ ] open_interest_analysis.md: Detailed guide on how to analyze open interest. +- [ ] liquidation_analysis.md: Detailed guide on how to analyze liquidation levels. diff --git a/skills/skill-adapter/references/best-practices.md b/skills/skill-adapter/references/best-practices.md new file mode 100644 index 0000000..3505048 --- /dev/null +++ b/skills/skill-adapter/references/best-practices.md @@ -0,0 +1,69 @@ +# Skill Best Practices + +Guidelines for optimal skill usage and development. + +## For Users + +### Activation Best Practices + +1. **Use Clear Trigger Phrases** + - Match phrases from skill description + - Be specific about intent + - Provide necessary context + +2. **Provide Sufficient Context** + - Include relevant file paths + - Specify scope of analysis + - Mention any constraints + +3. **Understand Tool Permissions** + - Check allowed-tools in frontmatter + - Know what the skill can/cannot do + - Request appropriate actions + +### Workflow Optimization + +- Start with simple requests +- Build up to complex workflows +- Verify each step before proceeding +- Use skill consistently for related tasks + +## For Developers + +### Skill Development Guidelines + +1. **Clear Descriptions** + - Include explicit trigger phrases + - Document all capabilities + - Specify limitations + +2. **Proper Tool Permissions** + - Use minimal necessary tools + - Document security implications + - Test with restricted tools + +3. **Comprehensive Documentation** + - Provide usage examples + - Document common pitfalls + - Include troubleshooting guide + +### Maintenance + +- Keep version updated +- Test after tool updates +- Monitor user feedback +- Iterate on descriptions + +## Performance Tips + +- Scope skills to specific domains +- Avoid overlapping trigger phrases +- Keep descriptions under 1024 chars +- Test activation reliability + +## Security Considerations + +- Never include secrets in skill files +- Validate all inputs +- Use read-only tools when possible +- Document security requirements diff --git a/skills/skill-adapter/references/examples.md b/skills/skill-adapter/references/examples.md new file mode 100644 index 0000000..b1d8bd2 --- /dev/null +++ b/skills/skill-adapter/references/examples.md @@ -0,0 +1,70 @@ +# Skill Usage Examples + +This document provides practical examples of how to use this skill effectively. + +## Basic Usage + +### Example 1: Simple Activation + +**User Request:** +``` +[Describe trigger phrase here] +``` + +**Skill Response:** +1. Analyzes the request +2. Performs the required action +3. Returns results + +### Example 2: Complex Workflow + +**User Request:** +``` +[Describe complex scenario] +``` + +**Workflow:** +1. Step 1: Initial analysis +2. Step 2: Data processing +3. Step 3: Result generation +4. Step 4: Validation + +## Advanced Patterns + +### Pattern 1: Chaining Operations + +Combine this skill with other tools: +``` +Step 1: Use this skill for [purpose] +Step 2: Chain with [other tool] +Step 3: Finalize with [action] +``` + +### Pattern 2: Error Handling + +If issues occur: +- Check trigger phrase matches +- Verify context is available +- Review allowed-tools permissions + +## Tips & Best Practices + +- ✅ Be specific with trigger phrases +- ✅ Provide necessary context +- ✅ Check tool permissions match needs +- ❌ Avoid vague requests +- ❌ Don't mix unrelated tasks + +## Common Issues + +**Issue:** Skill doesn't activate +**Solution:** Use exact trigger phrases from description + +**Issue:** Unexpected results +**Solution:** Check input format and context + +## See Also + +- Main SKILL.md for full documentation +- scripts/ for automation helpers +- assets/ for configuration examples diff --git a/skills/skill-adapter/scripts/README.md b/skills/skill-adapter/scripts/README.md new file mode 100644 index 0000000..087a9a7 --- /dev/null +++ b/skills/skill-adapter/scripts/README.md @@ -0,0 +1,8 @@ +# Scripts + +Bundled resources for crypto-derivatives-tracker skill + +- [ ] fetch_derivatives_data.py: Script to fetch and parse derivatives data from various exchanges. +- [ ] analyze_funding_rates.py: Script to analyze funding rates and identify potential trading signals. +- [ ] calculate_open_interest.py: Script to calculate open interest across different exchanges and contracts. +- [ ] liquidation_levels.py: Script to determine liquidation levels based on current market conditions. diff --git a/skills/skill-adapter/scripts/helper-template.sh b/skills/skill-adapter/scripts/helper-template.sh new file mode 100755 index 0000000..c4aae90 --- /dev/null +++ b/skills/skill-adapter/scripts/helper-template.sh @@ -0,0 +1,42 @@ +#!/bin/bash +# Helper script template for skill automation +# Customize this for your skill's specific needs + +set -e + +function show_usage() { + echo "Usage: $0 [options]" + echo "" + echo "Options:" + echo " -h, --help Show this help message" + echo " -v, --verbose Enable verbose output" + echo "" +} + +# Parse arguments +VERBOSE=false + +while [[ $# -gt 0 ]]; do + case $1 in + -h|--help) + show_usage + exit 0 + ;; + -v|--verbose) + VERBOSE=true + shift + ;; + *) + echo "Unknown option: $1" + show_usage + exit 1 + ;; + esac +done + +# Your skill logic here +if [ "$VERBOSE" = true ]; then + echo "Running skill automation..." +fi + +echo "✅ Complete" diff --git a/skills/skill-adapter/scripts/validation.sh b/skills/skill-adapter/scripts/validation.sh new file mode 100755 index 0000000..590af58 --- /dev/null +++ b/skills/skill-adapter/scripts/validation.sh @@ -0,0 +1,32 @@ +#!/bin/bash +# Skill validation helper +# Validates skill activation and functionality + +set -e + +echo "🔍 Validating skill..." + +# Check if SKILL.md exists +if [ ! -f "../SKILL.md" ]; then + echo "❌ Error: SKILL.md not found" + exit 1 +fi + +# Validate frontmatter +if ! grep -q "^---$" "../SKILL.md"; then + echo "❌ Error: No frontmatter found" + exit 1 +fi + +# Check required fields +if ! grep -q "^name:" "../SKILL.md"; then + echo "❌ Error: Missing 'name' field" + exit 1 +fi + +if ! grep -q "^description:" "../SKILL.md"; then + echo "❌ Error: Missing 'description' field" + exit 1 +fi + +echo "✅ Skill validation passed"