help
Access detailed documentation for Notion management tools when brief descriptions are insufficient, enabling AI agents to understand tool functionality and parameters.
Instructions
Get full documentation for a tool. Use when compressed descriptions are insufficient.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tool_name | Yes | Tool to get documentation for |
Implementation Reference
- src/tools/registry.ts:317-327 (handler)The switch case handler for the 'help' tool. It reads the markdown documentation file for the specified tool_name from the docs directory and returns it, or throws an error if not found.case 'help': { const toolName = (args as { tool_name: string }).tool_name const docFile = `${toolName}.md` try { const content = readFileSync(join(DOCS_DIR, docFile), 'utf-8') result = { tool: toolName, documentation: content } } catch { throw new NotionMCPError(`Documentation not found for: ${toolName}`, 'DOC_NOT_FOUND', 'Check tool_name') } break }
- src/tools/registry.ts:220-234 (registration)Registration of the 'help' tool in the TOOLS array returned by ListToolsRequestSchema handler. Includes name, description, and input schema definition.{ name: 'help', description: 'Get full documentation for a tool. Use when compressed descriptions are insufficient.', inputSchema: { type: 'object', properties: { tool_name: { type: 'string', enum: ['pages', 'databases', 'blocks', 'users', 'workspace', 'comments', 'content_convert'], description: 'Tool to get documentation for' } }, required: ['tool_name'] } }
- src/tools/registry.ts:223-233 (schema)Input schema for the 'help' tool, defining the required 'tool_name' parameter with valid enums.inputSchema: { type: 'object', properties: { tool_name: { type: 'string', enum: ['pages', 'databases', 'blocks', 'users', 'workspace', 'comments', 'content_convert'], description: 'Tool to get documentation for' } }, required: ['tool_name'] }