name: ai-agent-lint description: AI Agent code quality check - Use Ruff to check code standards for LangChain, AutoGen, and other AI Agent projects
AI Agent Lint Skill
๐ Overview
This skill uses Ruff (an extremely fast Python linter) to check AI Agent project code quality, specifically targeting:
- LangChain applications
- AutoGen multi-agent systems
- CrewAI collaborative agents
- General AI Agent development projects
๐ง Prerequisites
| Tool | Min Version | Check Command | Installation |
|---|---|---|---|
| Python | 3.10+ | python --version |
python.org |
| Ruff | 0.1.0+ | ruff --version |
pip install ruff |
Note: If Ruff is not installed, the script will provide a friendly prompt instead of failing.
๐ Usage
Method 1: Use AI Assistant
Tell the AI directly:
"Use ai-agent-lint skill to check my project"
AI will automatically:
- Read this SKILL.md to understand usage
- Execute the check script
- Report found issues
Method 2: Run Script Directly
Windows (PowerShell):
.\.agent\skills\ai-agent-lint\scripts\lint.ps1
Linux/Mac (Bash):
./.agent/skills/ai-agent-lint/scripts/lint.sh
Method 3: Specify Target Directory
# Windows
.\.agent\skills\ai-agent-lint\scripts\lint.ps1 -Path ".\src"
# Linux/Mac
./.agent/skills/ai-agent-lint/scripts/lint.sh src
๐ฏ What It Checks
Python Code Standards
- โ PEP 8 style compliance
- โ Type hint completeness
- โ Import statement ordering
- โ Unused variables and imports
- โ Code complexity check
AI Agent Specific Checks
- โ Prompt template string safety
- โ Hardcoded API key detection
- โ Async code patterns
- โ Error handling completeness
- โ Resource leak detection (unclosed LLM clients)
Security Checks
- โ ๏ธ
eval()andexec()usage warnings - โ ๏ธ SQL injection risks
- โ ๏ธ Sensitive data logging
- โ ๏ธ Unsafe deserialization
๐ Output Example
๐ AI Agent Lint - Checking project...
๐ Scanning directory: C:\Users\WJ\Desktop\MyAgent
๐ฆ Detected: LangChain project
โ
src/main.py - No issues
โ ๏ธ src/agent.py:15:1 - F401 [unused-import] 'os' imported but unused
โ src/config.py:23:5 - S105 [hardcoded-password-string] Possible hardcoded password
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
๐ Check Results:
โ
Passed: 45 files
โ ๏ธ Warnings: 3 issues
โ Errors: 1 issue
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
๐ก Tip: Run 'ruff check --fix' to auto-fix some issues
โ๏ธ Configuration
Create pyproject.toml or ruff.toml in the project root to customize rules:
# pyproject.toml
[tool.ruff]
line-length = 88
target-version = "py310"
[tool.ruff.lint]
select = [
"E", # pycodestyle errors
"W", # pycodestyle warnings
"F", # pyflakes
"I", # isort
"N", # pep8-naming
"S", # flake8-bandit (security)
"B", # flake8-bugbear
"C90", # mccabe complexity
]
ignore = ["E501"] # Ignore line length limit
[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"] # Allow unused imports in __init__.py
๐ Related Resources
๐ FAQ
Q: What if Ruff is not installed?
A: The script will detect and prompt installation: pip install ruff
Q: Can it be integrated into CI/CD?
A: Yes! Add to GitHub Actions:
- name: Lint AI Agent Code
run: |
pip install ruff
ruff check .
Q: How to auto-fix issues?
A: Run ruff check --fix or use the script's --fix parameter
Q: Does it support other AI frameworks?
A: Yes, it supports all Python-based AI Agent frameworks with universal rules