Initial commit

This commit is contained in:
Zhongwei Li
2025-11-29 18:52:09 +08:00
commit 4ef628103e
16 changed files with 1244 additions and 0 deletions

View File

@@ -0,0 +1,6 @@
# Assets
Bundled resources for api-contract-generator skill
- [ ] contract_template.json: A JSON template for the Pact contract, allowing customization of the contract structure.
- [ ] example_contract.json: An example of a generated Pact contract.

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

View File

@@ -0,0 +1,85 @@
{
"_comment": "Pact contract template. Customize this to match your API's structure.",
"provider": {
"name": "YourProviderAPI"
},
"consumer": {
"name": "YourConsumer"
},
"interactions": [
{
"_comment": "Example interaction. Modify as needed.",
"description": "A request for a user",
"request": {
"method": "GET",
"path": "/users/123",
"headers": {
"Accept": "application/json"
}
},
"response": {
"status": 200,
"headers": {
"Content-Type": "application/json; charset=utf-8"
},
"body": {
"id": 123,
"name": "John Doe",
"email": "john.doe@example.com",
"address": {
"street": "123 Main St",
"city": "Anytown",
"zip": "12345"
},
"_comment": "You can use Pact matchers here, e.g., using a regex to validate email format.",
"email_verification_status": "verified"
}
},
"providerStates": [
{
"name": "User 123 exists",
"params": {
"user_id": 123
}
}
]
},
{
"_comment": "Another example interaction - creating a new user.",
"description": "Creating a new user",
"request": {
"method": "POST",
"path": "/users",
"headers": {
"Content-Type": "application/json"
},
"body": {
"name": "Jane Smith",
"email": "jane.smith@example.com"
}
},
"response": {
"status": 201,
"headers": {
"Content-Type": "application/json; charset=utf-8",
"Location": "/users/456"
},
"body": {
"id": 456,
"name": "Jane Smith",
"email": "jane.smith@example.com"
}
},
"providerStates": [
{
"name": "The user service is available"
}
]
}
],
"metadata": {
"pactSpecification": {
"version": "3.0.0"
}
}
}

View File

@@ -0,0 +1,129 @@
{
"_comment": "Pact contract example generated by the api-contract-generator plugin.",
"provider": {
"name": "Article Service"
},
"consumer": {
"name": "Article Reader"
},
"interactions": [
{
"_comment": "An interaction represents a single request-response pair.",
"description": "a request for an article with ID 123",
"request": {
"method": "GET",
"path": "/articles/123",
"headers": {
"Accept": "application/json"
}
},
"response": {
"status": 200,
"headers": {
"Content-Type": "application/json; charset=utf-8"
},
"body": {
"_comment": "Example article data.",
"id": 123,
"title": "My First Article",
"content": "This is the content of my first article.",
"author": "John Doe",
"publicationDate": "2024-01-01T00:00:00Z",
"tags": ["news", "technology"]
},
"matchingRules": {
"_comment": "Define rules for matching request and response elements.",
"$.body.id": {
"match": "type"
},
"$.body.title": {
"match": "type"
},
"$.body.content": {
"match": "type"
},
"$.body.author": {
"match": "type"
},
"$.body.publicationDate": {
"match": "regex",
"regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$"
},
"$.body.tags": {
"match": "type"
}
}
},
"providerStates": [
{
"name": "an article with ID 123 exists",
"params": {
"articleId": 123
}
}
]
},
{
"_comment": "Another interaction representing a request for all articles.",
"description": "a request for all articles",
"request": {
"method": "GET",
"path": "/articles",
"headers": {
"Accept": "application/json"
},
"query": "page=1&limit=10"
},
"response": {
"status": 200,
"headers": {
"Content-Type": "application/json; charset=utf-8"
},
"body": [
{
"id": 123,
"title": "My First Article",
"content": "This is the content of my first article.",
"author": "John Doe",
"publicationDate": "2024-01-01T00:00:00Z",
"tags": ["news", "technology"]
},
{
"id": 456,
"title": "Another Article",
"content": "This is another article.",
"author": "Jane Smith",
"publicationDate": "2024-01-05T10:00:00Z",
"tags": ["sports", "local"]
}
],
"matchingRules": {
"$.body[*].id": {
"match": "type"
},
"$.body[*].title": {
"match": "type"
},
"$.body[*].content": {
"match": "type"
},
"$.body[*].author": {
"match": "type"
},
"$.body[*].publicationDate": {
"match": "regex",
"regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$"
},
"$.body[*].tags": {
"match": "type"
}
}
}
}
],
"metadata": {
"pactSpecification": {
"version": "3.0.0"
}
}
}

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

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

View File

@@ -0,0 +1,7 @@
# References
Bundled resources for api-contract-generator skill
- [ ] pact_best_practices.md: A document outlining best practices for using Pact for consumer-driven contract testing.
- [ ] api_specification_schema.json: A JSON schema defining the structure of the API specification used for contract generation.
- [ ] example_api_spec.yaml: An example API specification in YAML format.

View 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

View 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

View File

@@ -0,0 +1,6 @@
# Scripts
Bundled resources for api-contract-generator skill
- [ ] generate_pact_contract.py: A script to generate a Pact contract based on user input and API specifications.
- [ ] validate_contract.py: A script to validate the generated Pact contract against a schema or API definition.

View 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"

View 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"