get-ai-suggestions
@speakeasy-api/get-ai-suggestions
Use when SDK method names are ugly, wanting to improve operation IDs, or asking "how can I improve my spec"
Installation
$skills install @speakeasy-api/get-ai-suggestions
Claude Code
Cursor
Copilot
Codex
Antigravity
Details
Repositoryspeakeasy-api/speakeasy
Pathskills/get-ai-suggestions/SKILL.md
Branchmain
Scoped Name@speakeasy-api/get-ai-suggestions
Usage
After installing, this skill will be available to your AI coding assistant.
Verify installation:
skills listSkill Instructions
name: get-ai-suggestions description: Use when SDK method names are ugly, wanting to improve operation IDs, or asking "how can I improve my spec"
get-ai-suggestions
Use speakeasy suggest for AI-powered improvements.
Commands
# Suggest better operation IDs (method names)
speakeasy suggest operation-ids -s <spec-path>
# Suggest error type definitions
speakeasy suggest error-types -s <spec-path>
# Output suggestions as overlay file
speakeasy suggest operation-ids -s <spec-path> -o suggested-overlay.yaml
Operation ID Suggestions
Transforms auto-generated names into intuitive SDK method names:
get_api_v1_users_list→listUserspost_api_v1_users_create→createUser
Error Type Suggestions
Analyzes your API and suggests structured error responses:
- Common HTTP error codes (400, 401, 404, 500)
- Custom error schemas
Applying Suggestions
# Generate overlay with suggestions
speakeasy suggest operation-ids -s openapi.yaml -o operation-ids-overlay.yaml
# Add to workflow.yaml
sources:
my-api:
inputs:
- location: ./openapi.yaml
overlays:
- location: ./operation-ids-overlay.yaml
# Regenerate
speakeasy run
More by speakeasy-api
View allapply-openapi-overlay
377Use when applying an overlay file to a spec
merge-openapi-specs
377Use when combining multiple OpenAPI specs, or have microservices with separate spec files
diagnose-generation-failure
377name: diagnose-generation-failure
validate-openapi-spec
377Use when checking if an OpenAPI spec is valid, looking for errors, or running `speakeasy lint`