Initial commit
This commit is contained in:
7
skills/skill-adapter/assets/README.md
Normal file
7
skills/skill-adapter/assets/README.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Assets
|
||||
|
||||
Bundled resources for api-gateway-builder skill
|
||||
|
||||
- [ ] api_gateway_template.yaml: YAML template for defining API gateway configurations.
|
||||
- [ ] example_api_definition.json: Example API definition file.
|
||||
- [ ] error_response_templates/: Directory containing templates for different error responses (e.g., 400, 401, 500).
|
||||
55
skills/skill-adapter/assets/api_gateway_template.yaml
Normal file
55
skills/skill-adapter/assets/api_gateway_template.yaml
Normal file
@@ -0,0 +1,55 @@
|
||||
# API Gateway Configuration Template
|
||||
|
||||
# Gateway Metadata
|
||||
name: my-api-gateway # Name of the API gateway
|
||||
description: Production-ready API gateway configuration. # Description of the gateway
|
||||
|
||||
# Global Configuration
|
||||
global:
|
||||
# Default rate limit for all routes (requests per minute)
|
||||
default_rate_limit: 60 # Requests per minute
|
||||
# Enable/Disable global CORS settings. Set to 'true' or 'false'.
|
||||
enable_cors: true
|
||||
# Allowed origins for CORS (e.g., ['https://example.com', 'https://another.com', '*'])
|
||||
cors_allowed_origins: ['*'] # REPLACE_ME: List of allowed origins
|
||||
# Allowed methods for CORS (e.g., ['GET', 'POST', 'PUT', 'DELETE'])
|
||||
cors_allowed_methods: ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS']
|
||||
# Allowed headers for CORS (e.g., ['Content-Type', 'Authorization'])
|
||||
cors_allowed_headers: ['Content-Type', 'Authorization', 'YOUR_HEADER_HERE']
|
||||
# Expose headers for CORS (e.g., ['Content-Type', 'Authorization'])
|
||||
cors_exposed_headers: ['Content-Type', 'Authorization']
|
||||
|
||||
# Authentication Configuration
|
||||
authentication:
|
||||
# Authentication type: 'jwt' or 'none'
|
||||
type: jwt
|
||||
jwt:
|
||||
# JWT secret key (used for verifying signatures)
|
||||
secret: REPLACE_ME # JWT Secret Key
|
||||
# Audience (optional)
|
||||
audience: YOUR_VALUE_HERE # JWT Audience
|
||||
# Issuer (optional)
|
||||
issuer: YOUR_VALUE_HERE # JWT Issuer
|
||||
|
||||
# Routes Configuration
|
||||
routes:
|
||||
- path: /users # Path for the route
|
||||
method: GET # HTTP method (GET, POST, PUT, DELETE, etc.)
|
||||
upstream_url: http://users-service:8080 # URL of the upstream service
|
||||
rate_limit: 120 # Route-specific rate limit (overrides global default)
|
||||
authentication_required: true # Requires authentication for this route
|
||||
# Optional plugins to apply to this route
|
||||
plugins:
|
||||
- name: circuit-breaker
|
||||
config:
|
||||
failure_threshold: 5
|
||||
recovery_timeout: 30
|
||||
- path: /products
|
||||
method: POST
|
||||
upstream_url: http://products-service:8080
|
||||
rate_limit: 60
|
||||
authentication_required: true
|
||||
- path: /public
|
||||
method: GET
|
||||
upstream_url: http://public-service:8080
|
||||
authentication_required: false # Public route, no authentication required
|
||||
32
skills/skill-adapter/assets/config-template.json
Normal file
32
skills/skill-adapter/assets/config-template.json
Normal file
@@ -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": []
|
||||
}
|
||||
}
|
||||
104
skills/skill-adapter/assets/example_api_definition.json
Normal file
104
skills/skill-adapter/assets/example_api_definition.json
Normal file
@@ -0,0 +1,104 @@
|
||||
{
|
||||
"_comment": "Example API Definition - Use this as a template for your API gateway configuration.",
|
||||
"api_name": "MyAwesomeAPI",
|
||||
"version": "v1",
|
||||
"base_path": "/api/v1",
|
||||
"authentication": {
|
||||
"_comment": "Authentication configuration. 'jwt' is currently the only supported method.",
|
||||
"type": "jwt",
|
||||
"jwt": {
|
||||
"_comment": "JWT specific configuration.",
|
||||
"issuer": "https://my-auth-server.example.com",
|
||||
"jwks_uri": "https://my-auth-server.example.com/.well-known/jwks.json",
|
||||
"audience": "my-api-audience"
|
||||
}
|
||||
},
|
||||
"rate_limiting": {
|
||||
"_comment": "Global rate limiting configuration. Applies to all routes.",
|
||||
"enabled": true,
|
||||
"requests_per_minute": 100,
|
||||
"burst_size": 200,
|
||||
"identifier": "ip"
|
||||
},
|
||||
"routes": [
|
||||
{
|
||||
"_comment": "Route for getting user details.",
|
||||
"path": "/users/{user_id}",
|
||||
"method": "GET",
|
||||
"target_url": "http://user-service.example.com/users/{user_id}",
|
||||
"authentication_required": true,
|
||||
"rate_limiting": {
|
||||
"_comment": "Override global rate limiting for this route.",
|
||||
"enabled": true,
|
||||
"requests_per_minute": 20,
|
||||
"burst_size": 40,
|
||||
"identifier": "user_id"
|
||||
},
|
||||
"circuit_breaker": {
|
||||
"_comment": "Circuit breaker configuration for this route.",
|
||||
"enabled": true,
|
||||
"error_threshold_percentage": 50,
|
||||
"reset_timeout_ms": 30000,
|
||||
"volume_threshold": 10
|
||||
}
|
||||
},
|
||||
{
|
||||
"_comment": "Route for creating a new user.",
|
||||
"path": "/users",
|
||||
"method": "POST",
|
||||
"target_url": "http://user-service.example.com/users",
|
||||
"authentication_required": false,
|
||||
"rate_limiting": {
|
||||
"_comment": "Use global rate limiting."
|
||||
},
|
||||
"circuit_breaker": {
|
||||
"_comment": "Use global circuit breaker settings or disable circuit breaker",
|
||||
"enabled": false
|
||||
}
|
||||
},
|
||||
{
|
||||
"_comment": "Route for listing all products.",
|
||||
"path": "/products",
|
||||
"method": "GET",
|
||||
"target_url": "http://product-service.example.com/products",
|
||||
"authentication_required": true,
|
||||
"rate_limiting": {
|
||||
"_comment": "Override global rate limiting for this route.",
|
||||
"enabled": true,
|
||||
"requests_per_minute": 50,
|
||||
"burst_size": 100,
|
||||
"identifier": "ip"
|
||||
},
|
||||
"circuit_breaker": {
|
||||
"_comment": "Circuit breaker configuration for this route.",
|
||||
"enabled": true,
|
||||
"error_threshold_percentage": 50,
|
||||
"reset_timeout_ms": 30000,
|
||||
"volume_threshold": 10
|
||||
}
|
||||
},
|
||||
{
|
||||
"_comment": "Route for health check.",
|
||||
"path": "/health",
|
||||
"method": "GET",
|
||||
"target_url": "http://health-service.example.com/health",
|
||||
"authentication_required": false,
|
||||
"rate_limiting": {
|
||||
"_comment": "No rate limiting for health check.",
|
||||
"enabled": false
|
||||
},
|
||||
"circuit_breaker": {
|
||||
"_comment": "Disable circuit breaker for health check",
|
||||
"enabled": false
|
||||
}
|
||||
}
|
||||
],
|
||||
"load_balancing": {
|
||||
"_comment": "Load balancing configuration",
|
||||
"algorithm": "round_robin",
|
||||
"targets": [
|
||||
"http://user-service-instance1.example.com",
|
||||
"http://user-service-instance2.example.com"
|
||||
]
|
||||
}
|
||||
}
|
||||
28
skills/skill-adapter/assets/skill-schema.json
Normal file
28
skills/skill-adapter/assets/skill-schema.json
Normal file
@@ -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)"
|
||||
}
|
||||
}
|
||||
}
|
||||
27
skills/skill-adapter/assets/test-data.json
Normal file
27
skills/skill-adapter/assets/test-data.json
Normal file
@@ -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"
|
||||
}
|
||||
}
|
||||
9
skills/skill-adapter/references/README.md
Normal file
9
skills/skill-adapter/references/README.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# References
|
||||
|
||||
Bundled resources for api-gateway-builder skill
|
||||
|
||||
- [ ] api_gateway_best_practices.md: Documentation on best practices for designing and building API gateways.
|
||||
- [ ] jwt_authentication_guide.md: Detailed guide on implementing JWT authentication in the API gateway.
|
||||
- [ ] rate_limiting_strategies.md: Explanation of different rate limiting strategies and how to implement them.
|
||||
- [ ] microservice_integration_guide.md: Guide on integrating microservices with the API gateway.
|
||||
- [ ] api_gateway_schema.json: JSON schema defining the structure of API gateway configurations.
|
||||
69
skills/skill-adapter/references/best-practices.md
Normal file
69
skills/skill-adapter/references/best-practices.md
Normal file
@@ -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
|
||||
70
skills/skill-adapter/references/examples.md
Normal file
70
skills/skill-adapter/references/examples.md
Normal file
@@ -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
|
||||
7
skills/skill-adapter/scripts/README.md
Normal file
7
skills/skill-adapter/scripts/README.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Scripts
|
||||
|
||||
Bundled resources for api-gateway-builder skill
|
||||
|
||||
- [ ] create_api_gateway.py: Automates the creation of API gateway configurations based on user input.
|
||||
- [ ] deploy_api_gateway.sh: Script to deploy the API gateway to a specified environment.
|
||||
- [ ] test_api_gateway.py: Script to run automated tests against the deployed API gateway.
|
||||
42
skills/skill-adapter/scripts/helper-template.sh
Executable file
42
skills/skill-adapter/scripts/helper-template.sh
Executable file
@@ -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"
|
||||
32
skills/skill-adapter/scripts/validation.sh
Executable file
32
skills/skill-adapter/scripts/validation.sh
Executable file
@@ -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"
|
||||
Reference in New Issue
Block a user