sharp-edges

Documentation & Productivité

"Identify error-prone APIs and dangerous configurations"

Documentation

Sharp Edges

Overview

Identify error-prone APIs and dangerous configurations that could lead to bugs, security vulnerabilities, or system failures.

When to Use This Skill

Use this skill when you need to identify error-prone APIs and dangerous configurations.

Use this skill when:

●Reviewing code for potentially dangerous API usage
●Identifying configurations that could cause issues
●Analyzing code for error-prone patterns
●Assessing risk in API design or configuration choices
●Performing security audits focused on API misuse

Instructions

This skill helps identify problematic APIs and configurations:

1.API Analysis: Review API usage for error-prone patterns
2.Configuration Review: Identify dangerous or risky configurations
3.Pattern Recognition: Spot common mistakes and pitfalls
4.Risk Assessment: Evaluate the potential impact of identified issues

Common Sharp Edges

Error-Prone APIs

●APIs with complex parameter requirements
●APIs with non-obvious failure modes
●APIs that require careful resource management
●APIs with timing or concurrency issues
●APIs with unclear error handling

Dangerous Configurations

●Default settings that are insecure
●Configurations that bypass security controls
●Settings that enable dangerous features
●Options that reduce system reliability
●Parameters that affect performance negatively

Detection Strategies

1.Code Review: Look for known problematic patterns
2.Static Analysis: Use tools to identify risky API usage
3.Configuration Audits: Review configuration files for dangerous settings
4.Documentation Review: Check for warnings about API usage
5.Experience-Based: Leverage knowledge of common pitfalls

Best Practices

●Document identified sharp edges
●Provide clear guidance on safe usage
●Create examples of correct vs incorrect usage
●Recommend safer alternatives when available
●Update documentation with findings

Resources

For more information, see the [source repository](https://github.com/trailofbits/skills/tree/main/plugins/sharp-edges).

Compétences similaires

Explorez d'autres agents de la catégorie Documentation & Productivité

Voir tout le catalogue

php-pro

Write idiomatic PHP code with generators, iterators, SPL data

VOIR LA FICHE

writing-plans

Use when you have a spec or requirements for a multi-step task, before touching code

VOIR LA FICHE

python-packaging

Create distributable Python packages with proper project structure, setup.py/pyproject.toml, and publishing to PyPI. Use when packaging Python libraries, creating CLI tools, or distributing Python code.

VOIR LA FICHE
Utiliser l'Agent sharp-edges - Outil & Compétence IA | Skills Catalogue | Skills Catalogue