Documentation Endpoints

The Documentation category provides endpoints for accessing API documentation directly through the Smooth Operator Tools Server. These endpoints are designed to help agents and developers understand how to use the tools server without requiring external documentation.

ℹ️ These documentation endpoints are particularly useful for LLM agents that need to understand the available tools, their parameters, and how to use them effectively. They provide structured information that can be used to generate better prompts and more accurate tool calls.

Endpoints

Get Short Documentation

GET /tools-api/docs/explain-short

Provides a concise overview of the Smooth Operator Tools Server and its available endpoints.

Get Full API Documentation

GET /tools-api/docs/full

Returns the complete API documentation in Markdown format, including all endpoints, parameters, and examples.

Get Tool Documentation

GET /tools-api/docs/tool/{toolName}

Returns detailed documentation for a specific tool by name. Useful for understanding parameters and usage patterns for individual tools.

Usage Notes

MCP Integration: These documentation endpoints are registered as MCP (Model Context Protocol) tools, making them available to agent systems that integrate with the Smooth Operator Tools Server.
Tool Names: When using the tool-specific documentation endpoint, provide the tool name in snake_case format (e.g., mouse_click, automation_invoke).
Content Format: The short and full documentation endpoints return Markdown-formatted text, while the tool-specific documentation returns HTML content.
Authentication: Like all other endpoints, these documentation endpoints require authentication using a Bearer token.

Example Usage

Here's how you can use these documentation endpoints:

Get Short Documentation

curl -X GET "http://localhost:54321/tools-api/docs/explain-short" \
-H "Authorization: Bearer YOUR_API_KEY"

Get Full API Documentation

curl -X GET "http://localhost:54321/tools-api/docs/full" \
-H "Authorization: Bearer YOUR_API_KEY"

Get Documentation for a Specific Tool

curl -X GET "http://localhost:54321/tools-api/docs/tool/mouse_click" \
-H "Authorization: Bearer YOUR_API_KEY"