Tips

Docs server

• Be specific — mention endpoint names or operationIds when you know them
• Use domain terms — the search matches against path segments, descriptions, and tags
• Chain requests — ask the assistant to first search, then get_endpoint on the most relevant result
• Combine with code — look up the schema and generate TypeScript types, validation code, or API client methods in the same conversation

API server

• Start with a GET — explore a resource with a read-only call before writing
• Use a test API key — write operations (POST, PUT, PATCH, DELETE) make real changes; keep a separate test environment key
• Name your intent clearly — "update the status of order 123 to shipped" is better than "call the order endpoint"
• Pair with the docs server — connect both servers simultaneously; the assistant can look up the schema with the docs server, then execute with the API server