Look up an API operation
Returns what the GunSpec API reference documents for an endpoint: its parameters and accepted values, the plan it needs, whether a key is required, caching, every error status with the error.reason values to branch on, and the languages a sample is printed in. Use this tool before writing or explaining code that calls the GunSpec API, instead of recalling parameters. The path may be a template (/v1/firearms/{id}), a concrete path or a URL; a partial path such as /v1/vendor lists the operations under it.
Anwendungsbeispiel
- 1
Eine Person fragt
- What parameters does the GunSpec endpoint for a single firearm take, and what errors can it return?
- 2
Der Assistent ruft das Tool auf
tools/calljson{ "name": "gunspec_api_operation", "arguments": { "path": "/v1/firearms/{id}", "method": "GET" }} - 3
Der Server antwortet
Für dieses Tool liegt noch keine erfasste Antwort vor.
Zugehörige Referenzen
Argumente
- stringerforderlich
The endpoint path, e.g. "/v1/firearms/{id}", "/v1/firearms/glock-g17" or a full URL.
- Gesendet als
- ?path=
- string
HTTP method, when the path answers more than one.
- Akzeptiert
- Gesendet als
- ?method=
Jedes Argument wird als der angegebene Parameter an GET /v1/docs/operations gesendet. Dieselbe Anfrage lässt sich also mit deinem Schlüssel direkt an die API stellen, wenn du bestimmen möchtest, was zurückkommt.