Merge pull request #6 from gleanwork/naming-conventions

task: Updates tool names to be more specific (this matches other MCP server implementations)

Author: steve-calvert-glean

README.md

@@ -53,15 +53,36 @@ export GLEAN_API_TOKEN=your_api_token
 export GLEAN_ACT_AS=user@example.com
 ```
 
+## MCP Client Configuration
+
+To configure this MCP server in your MCP client (such as Claude Desktop, Windsurf, Cursor, etc.), add the following configuration to your MCP client settings:
+
+```json
+{
+  "mcpServers": {
+    "glean": {
+      "command": "npx",
+      "args": ["-y", "@gleanwork/mcp-server"],
+      "env": {
+        "GLEAN_SUBDOMAIN": "<glean instance subdomain>",
+        "GLEAN_API_TOKEN": "<glean api token>"
+      }
+    }
+  }
+}
+```
+
+Replace the environment variable values with your actual Glean credentials.
+
 ## Tools
 
-### search
+### glean_search
 
 Search Glean's content index using the Glean Search API. This tool allows you to query Glean's content index with various filtering and configuration options.
 
 For complete parameter details, see [Search API Documentation](https://developers.glean.com/client/operation/search/)
 
-### chat
+### glean_chat
 
 Interact with Glean's AI assistant using the Glean Chat API. This tool allows you to have conversational interactions with Glean's AI, including support for message history, citations, and various configuration options.
 
@@ -80,7 +101,7 @@ node build/index.js
 The server can also be run in inspect mode, which provides additional debugging information:
 
 ```bash
-pnpm inspect
+pnpm inspector
 ```
 
 This will run MCP's inspector, which allows you to execute and debug calls to the server.

src/index.ts

@@ -56,13 +56,13 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
   return {
     tools: [
       {
-        name: 'search',
-        description: 'Search Glean',
+        name: 'glean_search',
+        description: 'Search Glean Enterprise Knowledge',
         inputSchema: zodToJsonSchema(search.SearchSchema),
       },
       {
-        name: 'chat',
-        description: 'Chat with Glean',
+        name: 'glean_chat',
+        description: "Chat with Glean Assistant using Glean's RAG",
         inputSchema: zodToJsonSchema(chat.ChatSchema),
       },
     ],