Initial commit

skills/skill-adapter/assets/README.md

@@ -0,0 +1,6 @@
+# Assets
+
+Bundled resources for api-request-logger skill
+
+- [ ] logging_config_template.json: Template for logging configuration files, including settings for formatters, handlers, and log levels.
+- [ ] example_log_output.json: Example of structured log output in JSON format, demonstrating the use of correlation IDs and other metadata.

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": []
+  }
+}

skills/skill-adapter/assets/example_log_output.json

@@ -0,0 +1,122 @@
+{
+  "_comment": "Example log entry for a successful API request",
+  "level": "INFO",
+  "timestamp": "2024-01-26T10:00:00.000Z",
+  "message": "API request completed successfully",
+  "correlation_id": "a1b2c3d4e5f6g7h8i9j0",
+  "request": {
+    "method": "GET",
+    "url": "/api/users/123",
+    "headers": {
+      "Content-Type": "application/json",
+      "Authorization": "Bearer <redacted>"
+    }
+  },
+  "response": {
+    "status_code": 200,
+    "body_size": 150,
+    "response_time_ms": 75
+  },
+  "user": {
+    "user_id": "user123",
+    "username": "testuser"
+  },
+  "application": "my-app",
+  "environment": "production",
+  "log_type": "api_request",
+  "source": "api-request-logger",
+  "_comment": "Optional fields for request context"
+},
+{
+  "_comment": "Example log entry for an API request that resulted in an error",
+  "level": "ERROR",
+  "timestamp": "2024-01-26T10:00:05.000Z",
+  "message": "API request failed with error",
+  "correlation_id": "b2c3d4e5f6g7h8i9j0a1",
+  "request": {
+    "method": "POST",
+    "url": "/api/orders",
+    "headers": {
+      "Content-Type": "application/json",
+      "Authorization": "Bearer <redacted>"
+    },
+    "body": "{\"item_id\": \"456\", \"quantity\": 2}"
+  },
+  "response": {
+    "status_code": 500,
+    "error_message": "Internal Server Error",
+    "response_time_ms": 120
+  },
+  "user": {
+    "user_id": "user456",
+    "username": "anotheruser"
+  },
+  "application": "my-app",
+  "environment": "production",
+  "log_type": "api_request",
+  "source": "api-request-logger",
+  "error": {
+    "type": "ServerError",
+    "message": "Database connection failed"
+  },
+  "_comment": "Error details included for debugging"
+},
+{
+  "_comment": "Example log entry for a timed out API request",
+  "level": "WARN",
+  "timestamp": "2024-01-26T10:00:10.000Z",
+  "message": "API request timed out",
+  "correlation_id": "c3d4e5f6g7h8i9j0a1b2",
+  "request": {
+    "method": "GET",
+    "url": "/api/slow-endpoint",
+    "headers": {
+      "Content-Type": "application/json",
+      "Authorization": "Bearer <redacted>"
+    }
+  },
+  "response": {
+    "status_code": 408,
+    "error_message": "Request Timeout",
+    "response_time_ms": 30000
+  },
+  "user": {
+    "user_id": "user789",
+    "username": "timeoutuser"
+  },
+  "application": "my-app",
+  "environment": "staging",
+  "log_type": "api_request",
+  "source": "api-request-logger",
+  "timeout_ms": 30000,
+  "_comment": "Included timeout value"
+},
+{
+  "_comment": "Example log entry for an API request with missing authorization",
+  "level": "WARN",
+  "timestamp": "2024-01-26T10:00:15.000Z",
+  "message": "API request missing authorization header",
+  "correlation_id": "d4e5f6g7h8i9j0a1b2c3",
+  "request": {
+    "method": "POST",
+    "url": "/api/sensitive-data",
+    "headers": {
+      "Content-Type": "application/json"
+    },
+    "body": "{ \"sensitive_info\": \"secret\" }"
+  },
+  "response": {
+    "status_code": 401,
+    "error_message": "Unauthorized",
+    "response_time_ms": 50
+  },
+  "application": "my-app",
+  "environment": "staging",
+  "log_type": "api_request",
+  "source": "api-request-logger",
+  "security": {
+    "missing_authorization": true
+  },
+  "_comment": "Flagging the missing authorization"
+}
+]

skills/skill-adapter/assets/logging_config_template.json

@@ -0,0 +1,68 @@
+{
+  "_comment": "Template for logging configuration.  Customize this to fit your needs.",
+  "version": 1,
+  "disable_existing_loggers": false,
+  "formatters": {
+    "standard": {
+      "_comment": "Standard log format with timestamp, level, and message.",
+      "format": "%(asctime)s - %(levelname)s - %(name)s - %(correlation_id)s - %(message)s"
+    },
+    "json": {
+      "_comment": "JSON log format for easier parsing by log aggregation tools.",
+      "format": "{\"timestamp\": \"%(asctime)s\", \"level\": \"%(levelname)s\", \"name\": \"%(name)s\", \"correlation_id\": \"%(correlation_id)s\", \"message\": \"%(message)s\", \"module\": \"%(module)s\", \"funcName\": \"%(funcName)s\", \"lineno\": %(lineno)d}"
+    }
+  },
+  "handlers": {
+    "console": {
+      "_comment": "Console handler for local development.",
+      "class": "logging.StreamHandler",
+      "level": "INFO",
+      "formatter": "standard",
+      "stream": "ext://sys.stdout"
+    },
+    "file": {
+      "_comment": "File handler for persistent logging.",
+      "class": "logging.handlers.RotatingFileHandler",
+      "level": "DEBUG",
+      "formatter": "standard",
+      "filename": "/var/log/api_requests.log",
+      "maxBytes": 10485760,
+      "backupCount": 5,
+      "encoding": "utf8"
+    },
+    "json_file": {
+      "_comment": "JSON file handler for persistent logging in JSON format",
+      "class": "logging.handlers.RotatingFileHandler",
+      "level": "DEBUG",
+      "formatter": "json",
+      "filename": "/var/log/api_requests.json",
+      "maxBytes": 10485760,
+      "backupCount": 5,
+      "encoding": "utf8"
+    }
+  },
+  "loggers": {
+    "api_request_logger": {
+      "_comment": "Logger for API requests.",
+      "level": "DEBUG",
+      "handlers": ["console", "file", "json_file"],
+      "propagate": false
+    },
+    "other_module": {
+      "_comment": "Example of another module's logger.",
+      "level": "WARNING",
+      "handlers": ["console"],
+      "propagate": true
+    }
+  },
+  "root": {
+    "_comment": "Root logger configuration.",
+    "level": "WARNING",
+    "handlers": ["console"]
+  },
+  "correlation_id": {
+    "_comment": "Configuration for correlation ID generation.",
+    "header_name": "X-Correlation-ID",
+    "generator": "uuid"
+  }
+}

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)"
+    }
+  }
+}

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"
+  }
+}

skills/skill-adapter/references/README.md

@@ -0,0 +1,7 @@
+# References
+
+Bundled resources for api-request-logger skill
+
+- [ ] logging_best_practices.md: Detailed guide on best practices for structured logging, including formatting, levels, and security considerations.
+- [ ] correlation_id_implementation.md: Explanation of how correlation IDs are implemented and used for tracing requests across services.
+- [ ] log_aggregation_setup.md: Instructions on setting up log aggregation using popular tools like Elasticsearch, Logstash, and Kibana (ELK stack).

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

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

skills/skill-adapter/scripts/README.md

@@ -0,0 +1,7 @@
+# Scripts
+
+Bundled resources for api-request-logger skill
+
+- [ ] setup_logging.sh: Automates the setup of logging configurations based on environment variables and best practices.
+- [ ] generate_correlation_id.py: Generates a unique correlation ID for each API request.
+- [ ] aggregate_logs.py: Script to aggregate logs from different sources into a centralized logging system.

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"

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"