api-doc-to-tool-spec
Skill0 starsChanged 5 months agoMITView on GitHub
Use when converting API documentation, endpoint notes, OpenAPI snippets, or integration docs into an agent-ready tool specification with capabilities, inputs, auth, examples, and operational risks.
In this repository19 other files it gives its agents.
- agent-handoff-briefSkill
- architecture-rfc-reviewSkill
- bug-report-to-reproSkill
- changelog-to-upgrade-planSkill
- competitive-research-briefSkill
- customer-call-to-prdSkill
- database-migration-risk-reviewSkill
- dependency-upgrade-risk-reviewSkill
- incident-log-to-postmortemSkill
- messy-notes-to-decision-logSkill
- privacy-data-flow-mapSkill
- prompt-to-eval-rubricSkill
- repo-launch-readiness-reviewSkill
- roadmap-to-release-planSkill
- security-review-checklistSkill
- support-ticket-to-evalSkill
- telemetry-to-product-insightsSkill
- tool-permission-auditSkill
- workflow-automation-scoutSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 14
Use when source docs describe API behavior but an agent needs a safer tool contract before implementation or automation.
- Distinctive: line 15
Do not use when the source is only product intent with no endpoint, auth, or data-shape evidence.
- Distinctive: line 29
Add one minimal example request and one expected response shape per core operation.
- Distinctive: line 45
Every capability maps back to evidence in the source docs.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
API Doc To Tool Spec
Purpose
Turn API documentation into a compact tool specification an agent can safely use or hand to an implementer.
Fit
- Use when source docs describe API behavior but an agent needs a safer tool contract before implementation or automation.
- Do not use when the source is only product intent with no endpoint, auth, or data-shape evidence.
Inputs
- Endpoint docs, OpenAPI snippets, SDK examples, or integration notes.
- Auth requirements, rate limits, scopes, and sample requests if available.
- The intended agent workflow or user task.
Workflow
- Identify each capability the API exposes in plain language.
- Extract required inputs, optional inputs, output shape, auth scopes, and errors.
- Mark unclear fields as assumptions instead of guessing.
- Separate read-only operations from write or destructive operations.
- Add one minimal example request and one expected response shape per core operation.
Output
Produce Markdown with:
- Tool Summary
- Capability Table
- Inputs And Outputs
- Auth And Rate Limits
- Example Calls
- Risks And Approval Gates
- Open Questions
Validation
- Every capability maps back to evidence in the source docs.
- Required inputs are not mixed with optional inputs.
- Auth scopes and write operations are explicit.
- Unknown behavior is listed under open questions.
- Examples are small and do not include real secrets or private data.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.