openai-knowledge

Retrieve OpenAI API endpoint documentation and OpenAPI specifications via MCP server tools.

6|2|Updated Aug 22, 2024
One-click install
npx skills add https://github.com/NQ-lovecpp/cpp_chatsystem --skill openai-knowledge-nq-lovecpp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openai-knowledge
Source: https://github.com/NQ-lovecpp/cpp_chatsystem/tree/main/ChatSystem-Backend/8.Agent_Server/examples/openai-agents-python-main/.agents/skills/openai-knowledge
Command: npx skills add https://github.com/NQ-lovecpp/cpp_chatsystem --skill openai-knowledge-nq-lovecpp

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides access to authoritative, up-to-date documentation for the OpenAI API and platform features, eliminating guesswork and ensuring accurate implementation.

Core Features & Use Cases

  • API Documentation: Retrieve schemas, examples, limits, and edge cases for OpenAI APIs.
  • Platform Features: Get information on tools, streaming, Realtime API, authentication, models, and more.
  • Use Case: When encountering an error related to OpenAI API rate limits, use this Skill to fetch the exact documentation on current limits and best practices for handling them.

Quick Start

Use the openai-knowledge skill to search for documentation on OpenAI API streaming.

Frequently Asked Questions about openai-knowledge

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find current OpenAI API rate limits and best practices for handling them?

To find OpenAI API rate limits and best practices, retrieve the official documentation via this skill. It fetches precise details on current thresholds, parameters, and edge cases directly from the OpenAPI specifications and markdown content.

What is the correct authentication schema for OpenAI API endpoints?

The correct authentication schema for OpenAI API endpoints is detailed in the platform documentation. This skill retrieves authoritative information on schemas, parameters, and authentication methods to ensure accurate API implementation.

Can I retrieve OpenAI platform documentation for Realtime API and streaming features?

Yes, you can retrieve OpenAI platform documentation for Realtime API and streaming features. This skill accesses official markdown content to provide precise details on platform tools, streaming mechanisms, and related concepts.

Does this skill provide OpenAPI specifications for OpenAI API endpoints?

Yes, this skill provides OpenAPI specifications for OpenAI API endpoints. It leverages MCP server tools for direct access to specifications, retrieving schemas, examples, limits, and edge cases for OpenAI services.

Why does my OpenAI API implementation fail due to outdated endpoint schemas?

Your OpenAI API implementation may fail due to outdated endpoint schemas if not using official documentation. This skill retrieves up-to-date markdown content and OpenAPI specifications, eliminating guesswork and ensuring accurate implementation.

What is the best way to access official OpenAI developer docs for API parameters?

The best way to access official OpenAI developer docs for API parameters is through this skill. It retrieves authoritative documentation directly, supporting scenarios requiring precise details on schemas, limits, and best practices.