wpnav.help
Check WordPress connection status, view environment hints, and get next steps for managing your site through natural language commands.
Instructions
Alias for wpnav_help. Returns connection status, env hints and next steps.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/core/index.ts:28-63 (handler)The asynchronous handler function that implements the core logic for the 'wpnav_help' tool (aliased as 'wpnav.help'). It generates and returns a markdown-formatted help message with connection status, environment details, and quickstart instructions.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, category, and aliases (including 'wpnav.help' for backward compatibility).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:27-36 (schema)Schema definition for the 'wpnav.help' tool alias in the central tools list, matching the main tool's empty input schema.{ name: 'wpnav.help', description: 'Alias for wpnav_help. Returns connection status, env hints and next steps.', inputSchema: { type: 'object' as const, properties: {}, required: [], }, },
- src/tools/index.ts:24-33 (registration)Top-level tool registration function that calls registerCoreTools(), indirectly registering the wpnav.help tool.export function registerAllTools() { registerCoreTools(); registerContentTools(); registerTaxonomyTools(); registerUserTools(); registerPluginTools(); registerThemeTools(); registerTestingTools(); registerGutenbergTools(); }