wpnav_help
Check connection status and access quickstart actions for managing WordPress content through natural language commands with safe write operations.
Instructions
Get connection status, environment hints, and quickstart actions for using WP Navigator MCP with CLI clients.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/core/index.ts:28-63 (handler)The handler function that executes the wpnav_help tool logic. It generates and returns a markdown help message with environment info, quickstart guide, and tool categories.handler: async (args, context) => { const { config } = context; const hints = [ '# WP Navigator MCP - Connected! 🎉', '', '## Environment', `- WordPress: ${config.baseUrl}`, `- REST API: ${config.restApi}`, `- WPNav Base: ${config.wpnavBase}`, `- Writes: ${config.toggles.enableWrites ? '✅ Enabled' : '❌ Disabled'}`, '', '## Quick Start', '1. Call **wpnav_introspect** to get API capabilities and policy', '2. Use **wpnav_list_*** tools to browse content (pages, posts, etc.)', '3. Use **wpnav_get_*<id>** to fetch specific items', '4. Use **wpnav_create_***, **wpnav_update_***, **wpnav_delete_*** for mutations', '', '## Available Categories', '- Content: pages, posts, media, comments', '- Taxonomy: categories, tags, taxonomies', '- Users: user management', '- Plugins: plugin management', '- Themes: theme management', '', '## Need Help?', '- Run **wpnav_introspect** for detailed API capabilities', '- All tool names follow pattern: wpnav_{action}_{resource}', '', '🚀 Ready to build with WordPress!', ]; return { content: [{ type: 'text', text: hints.join('\n') }], }; },
- src/tools/core/index.ts:17-66 (registration)Registration of the wpnav_help tool in the tool registry, including definition (name, description, schema), handler reference, category, and aliases.toolRegistry.register({ definition: { name: 'wpnav_help', description: 'Get connection status, environment hints, and quickstart actions for using WP Navigator MCP with CLI clients.', inputSchema: { type: 'object', properties: {}, required: [], }, }, handler: async (args, context) => { const { config } = context; const hints = [ '# WP Navigator MCP - Connected! 🎉', '', '## Environment', `- WordPress: ${config.baseUrl}`, `- REST API: ${config.restApi}`, `- WPNav Base: ${config.wpnavBase}`, `- Writes: ${config.toggles.enableWrites ? '✅ Enabled' : '❌ Disabled'}`, '', '## Quick Start', '1. Call **wpnav_introspect** to get API capabilities and policy', '2. Use **wpnav_list_*** tools to browse content (pages, posts, etc.)', '3. Use **wpnav_get_*<id>** to fetch specific items', '4. Use **wpnav_create_***, **wpnav_update_***, **wpnav_delete_*** for mutations', '', '## Available Categories', '- Content: pages, posts, media, comments', '- Taxonomy: categories, tags, taxonomies', '- Users: user management', '- Plugins: plugin management', '- Themes: theme management', '', '## Need Help?', '- Run **wpnav_introspect** for detailed API capabilities', '- All tool names follow pattern: wpnav_{action}_{resource}', '', '🚀 Ready to build with WordPress!', ]; return { content: [{ type: 'text', text: hints.join('\n') }], }; }, category: ToolCategory.CORE, aliases: ['wpnav.help'], // Backward compatibility });
- src/tools.ts:17-25 (schema)Schema definition for wpnav_help tool in the main tools list, matching the registered definition.{ name: 'wpnav_help', description: 'Get connection status, environment hints, and quickstart actions for using WP Navigator MCP with CLI clients.', inputSchema: { type: 'object' as const, properties: {}, required: [], },
- src/tools.ts:27-35 (schema)Schema definition for the wpnav.help alias in the main tools list.{ name: 'wpnav.help', description: 'Alias for wpnav_help. Returns connection status, env hints and next steps.', inputSchema: { type: 'object' as const, properties: {}, required: [], },