read_pubnub_sdk_docs
Retrieve PubNub SDK documentation for specific programming languages and API reference sections. Provides code examples, usage patterns, and low-level API details in markdown format.
Instructions
Retrieves official PubNub SDK documentation for a given programming language and API reference section. Call this tool for low-level API details, code examples, and usage patterns. Returns documentation in markdown format. For conceptual guides, best practices, and how-tos, also call the read_pubnub_resources tool.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| apiReference | No | API reference section to retrieve (e.g. configuration, publish-and-subscribe, objects (App Context); defaults to configuration) | configuration |
| language | Yes | Programming language of the PubNub SDK to retrieve documentation for (e.g. javascript, python) |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"apiReference": {
"default": "configuration",
"description": "API reference section to retrieve (e.g. configuration, publish-and-subscribe, objects (App Context); defaults to configuration)",
"enum": [
"configuration",
"publish-and-subscribe",
"presence",
"access-manager",
"channel-groups",
"storage-and-playback",
"mobile-push",
"objects",
"App Context",
"files",
"message-actions",
"misc",
"functions"
],
"type": "string"
},
"language": {
"description": "Programming language of the PubNub SDK to retrieve documentation for (e.g. javascript, python)",
"enum": [
"javascript",
"python",
"java",
"go",
"ruby",
"swift",
"objective-c",
"c-sharp",
"php",
"dart",
"rust",
"unity",
"kotlin",
"unreal",
"c-core",
"rest-api"
],
"type": "string"
}
},
"required": [
"language"
],
"type": "object"
}