Usage Guide
localnest_usage_guideRead-onlyIdempotent
Get best-practice guidance for using LocalNest MCP to access codebases locally with file discovery, search, and project introspection while keeping data on your machine.
Instructions
Return concise best-practice guidance for users and AI agents using this MCP.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| response_format | No | json |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| meta | No |
Implementation Reference
- src/mcp/common/status.js:126-150 (handler)Implementation of the buildUsageGuide function, which provides the response for the localnest_usage_guide tool.
export function buildUsageGuide() { return { quickstart: [ '1. Run localnest_server_status to confirm runtime health and active roots.', '2. Use localnest_search_files to find a module, feature, or folder by name.', '3. Use localnest_search_code for exact symbols, imports, and error strings.', '4. Use localnest_read_file only after narrowing the target.' ], release_debug: [ 'If retrieval looks empty, validate project_path first, then retry with a broader query.', 'If runtime looks degraded, inspect server_status.health and updates before deeper debugging.', 'Use localnest_update_status to see whether cached version data is stale or actionable.' ], for_users: [ 'Run localnest_list_roots first to verify active roots.', 'Use localnest_list_projects to discover projects under a root.', 'Run localnest_index_project for your active project/root before semantic search.', 'Use localnest_search_hybrid for low-noise retrieval.', 'Use localnest_read_file for targeted context windows.', 'Use localnest_task_context for one-call runtime + memory context before non-trivial work.', 'Use localnest_capture_outcome for one-call outcome capture after meaningful work.', 'Use localnest_memory_status to verify whether local memory is enabled and supported on this runtime.', 'Use localnest_memory_capture_event to preserve durable project decisions and preferences after meaningful work.', 'Use localnest_update_status when you need to verify whether a newer stable version is available.' ], - src/mcp/tools/core.js:57-71 (registration)Registration of the localnest_usage_guide tool in the core tools registry.
registerJsonTool( 'localnest_usage_guide', { title: 'Usage Guide', description: 'Return concise best-practice guidance for users and AI agents using this MCP.', inputSchema: {}, annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false } }, async () => buildUsageGuide() );