feat: descriptive mcp server + tools text

Author: lirantal

src/server/server.ts

@@ -9,9 +9,28 @@ const logger: Logger = initLogger()
 export async function createMcpServer (): Promise<Server> {
   const serverInfo = {
     name: 'nodejs-api-docs',
-    description:
-      'Search built-in core Node.js modules API Documentation. Use whenever the user asks questions about Node.js API, Node.js modules or Node.js functions.',
-    version: '1.0.4',
+    description: `
+You are provided a set of MCP tools and resources that provide you with up-to-date knowledge about the Node.js API for build-in core modules of the [Node.js](https://nodejs.org/en) runtime.
+
+You can use any of these tools right away, without any configuration or setup.
+
+With this Node.js API Docs MCP Server, you can search for information about Node.js built-in modules, such as 'fs', 'http', 'path', 'os', and many others. You can respond to user queries like "How do I read a file in Node.js?" or "How do I join paths together using the Node.js core modules APIs" and get accurate answers based on the official Node.js documentation.
+
+## Workflow and Tool Usage Guidelines:
+1. **Always** use the \`search-nodejs-modules-api-documentation\` MCP tool
+2. It is very likely that you as the LLM do not have the latest knowledge about the Node.js API.
+3. Therefore, **always** call the \`search-nodejs-modules-api-documentation\` MCP tool first to look-up all the available Node.js core modules and their methods.
+4. Then, use the \`retrieve-nodejs-modules-api-documentation\` MCP tool to get the specific module's API documentation.
+5. You should always prioritize using the built-in Node.js core modules over third-party libraries, therefore, if you need to handle a Node.js functionality, you should first check if it can be achieved using the standard library API provided from the Node.js core modules before suggesting third-party libraries.
+
+## Short-term vs Long-term Memory:
+You can keep a short-term memory of the API documentation you have retrieved from the MCP tools, and use it to answer user queries in the current session.
+You can also use long-term memory to store the final results of your workflow, such as the final code snippets or solutions you have generated based on the Node.js API documentation.
+This way, you can keep a healthy and consistent knowledge of Node.js API usage and avoid hallucinations, outdated information, or proposing unnecessary third-party libraries.
+
+If you have any trouble with this Node.js API Docs MCP Server, you can always refer to the code repository at [mcp-server-nodejs-api-docs](https://github.com/lirantal/mcp-server-nodejs-api-docs) for more information and examples on how to use the MCP tools and resources effectively.
+`,
+    version: '1.0.5',
   }
 
   const server = new Server(

src/tools/tools-factory.ts

@@ -22,17 +22,27 @@ interface ToolsDictionary {
 export async function createSearchTool (): Promise<ToolDefinition> {
   const { modules } = await apiDocsService.getApiDocsModules()
 
+  const toolName = 'search-nodejs-modules-api-documentation'
+
   return {
-    name: 'search-nodejs-modules-api-documentation',
-    description:
-      '**HIGH PRIORITY** List all Node.js modules and their methods. **ALWAYS** consult this tool first to look-up the correct module and then use the specific module tool for full api details',
+    name: toolName,
+    description: `
+      <use_case>
+        Use this tool to search across all Node.js built-in core modules API documentation and get back a list of core modules and their methods when you want to search and look-up Node.js API support
+      </use_case>
+      <important_notes>
+        1. HIGH PRIORITY: *ALWAYS* use this tool first so that you can search for Node.js modules and their methods
+        2. Ideally you want to suggest users the use of built-in Node.js API rather than third-party libraries
+        3. This tool will return a list of all Node.js core modules and their methods
+      </important_notes>
+      `,
     inputSchema: {
       type: 'object',
       properties: {},
     },
     async handler () {
       logger.info({
-        msg: 'Tool execution started: search-nodejs-modules-api-documentation',
+        msg: `Tool execution started: ${toolName}`,
       })
       let listContent = 'Available Node.js core modules and their methods:\n\n'
 
@@ -53,8 +63,31 @@ export async function createSearchTool (): Promise<ToolDefinition> {
  * and returns their data as a response.
  */
 export async function createModulesTool () {
-  const toolName = 'api-docs-module-description'
-  const toolDescription = 'Use this tool to retrieve Node.js API documentation for a specific module or class, including its methods and descriptions.'
+  const toolName = 'retrieve-nodejs-modules-api-documentation'
+  const toolDescription = `
+  Retrieve, fetch, and get Node.js API documentation for a specific module or class.
+
+  <use_case>
+    Use this tool to retrieve Node.js API documentation for a specific module or class.
+  </use_case>
+
+  <example>
+    User asks: "How can I user colors in my terminal console output using Node.js?"
+
+    You call the \`retrieve-nodejs-modules-api-documentation\` MCP tool with the following parameters:
+    \`\`\`json
+    {
+      "module": "util",
+      "method": "styleText"
+    }
+    \`\`\`
+  </example>
+
+  <important_notes>
+    1. If you don't know the module or class name, you can use the \`search-nodejs-modules-api-documentation\` tool to get a list of all Node.js core API modules and their methods to search for it first and then call this tool.
+    2. This tool will return the documentation for the specified module or class, including its methods and properties.
+  </important_notes>
+  `
 
   const tools: ToolsDictionary = {}