al-go-mcp-server 1.0.0 → 1.0.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Job Louage
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Job Louage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,44 +1,163 @@
-# AL-Go MCP Server
-
-A Model Context Protocol (MCP) server for accessing AL-Go documentation and workflows from the `microsoft/AL-Go` repository.
-
-## Features
-- Search and access AL-Go documentation and workflows
-- Works with public GitHub API (no token required for public repos)
-- Optional: Use a GitHub token for higher rate limits
-- Can be run via `npx` and configured in `.vscode/mcp.json`
-
-## Usage
-
-### 1. As a local or global npm package
-
-```
-npx al-go-mcp-server
-```
-
-### 2. In `.vscode/mcp.json`
-
-```json
-{
-  "servers": {
-    "al-go-docs": {
-      "type": "stdio",
-      "command": "npx",
-      "args": ["al-go-mcp-server"],
-      "env": {
-        "GITHUB_TOKEN": "your_token_here" // Optional
-      }
-    }
-  }
-}
-```
-
-## Development
-
-- Clone the repo
-- Run `npm install`
-- Run `npm run build`
-- Run `npm start` or `npx tsx src/index.ts`
-
-## License
-MIT
+# AL-Go MCP Server
+
+A Model Context Protocol (MCP) server that provides access to AL-Go documentation and resources from the [microsoft/AL-Go](https://github.com/microsoft/AL-Go) repository.
+
+## Repository
+
+🔗 **GitHub Repository**: [https://github.com/louagej/al-go-mcp-server](https://github.com/louagej/al-go-mcp-server)  
+📦 **npm Package**: [https://www.npmjs.com/package/al-go-mcp-server](https://www.npmjs.com/package/al-go-mcp-server)
+
+## Features
+
+- 🔍 **Search AL-Go Documentation**: Search through comprehensive AL-Go guides and documentation
+- 📋 **Workflow Examples**: Access and explore AL-Go workflow templates and examples  
+- 📖 **Repository Navigation**: Browse AL-Go repository contents and resources
+- ⚡ **Performance Optimized**: Cached responses and efficient GitHub API usage
+- 🔐 **Optional Authentication**: Support for GitHub tokens for higher rate limits
+- 🚀 **Easy Installation**: Available via npm and npx for instant usage
+
+## Installation
+
+### With npm
+
+```bash
+# Install globally for command line usage
+npm install -g al-go-mcp-server
+
+# Or use directly with npx (no installation required)
+npx al-go-mcp-server
+```
+
+
+## Usage
+
+### VS Code with MCP Extension (Recommended)
+
+You can configure the AL-Go MCP server in two ways:
+
+#### Option 1: User Settings (Recommended)
+Add to your **User MCP Configuration** for access across all projects in the same VS Code profile:
+
+> **Note**: User settings are profile-specific. The server will be available for all projects opened with the same VS Code profile (e.g., "Node.js", "Default", etc.).
+
+1. Open VS Code Command Palette (`Ctrl+Shift+P`)
+2. Run **"MCP: Open User Configuration"**
+3. Add the server configuration:
+
+```json
+{
+  "servers": {
+    "al-go-docs": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["al-go-mcp-server"]
+    }
+  },
+  "inputs": []
+}
+```
+
+#### Option 2: Project Settings
+Add to your project's `.vscode/mcp.json` for project-specific configuration:
+
+```json
+{
+  "servers": {
+    "al-go-docs": {
+      "type": "stdio", 
+      "command": "npx",
+      "args": ["al-go-mcp-server"]
+    }
+  }
+}
+```
+
+### With GitHub Authentication (Optional)
+
+For higher rate limits and better performance, provide a GitHub token. This can be added to either user or project settings:
+
+**User Settings** (add `env` to the server configuration):
+```json
+{
+  "servers": {
+    "al-go-docs": {
+      "type": "stdio",
+      "command": "npx", 
+      "args": ["al-go-mcp-server"],
+      "env": {
+        "GITHUB_TOKEN": "your_github_token_here"
+      }
+    }
+  },
+  "inputs": []
+}
+```
+
+**Project Settings** (`.vscode/mcp.json`):
+```json
+{
+  "servers": {
+    "al-go-docs": {
+      "type": "stdio",
+      "command": "npx", 
+      "args": ["al-go-mcp-server"],
+      "env": {
+        "GITHUB_TOKEN": "your_github_token_here"
+      }
+    }
+  }
+}
+```
+
+### Command Line (Advandced)
+
+```bash
+# If installed globally
+al-go-mcp-server
+
+# Or using npx (no installation needed)
+npx al-go-mcp-server
+```
+
+
+## Available Tools
+
+When connected, the server provides these tools:
+
+- **`search-al-go-docs`**: Search through AL-Go documentation with queries
+- **`get-al-go-workflows`**: Get examples of AL-Go GitHub workflows  
+- **`refresh-al-go-cache`**: Refresh cached documentation (force update)
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/louagej/al-go-mcp-server.git
+cd al-go-mcp-server
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Run locally
+npm start
+# or
+npx tsx src/index.ts
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT - see [LICENSE](LICENSE) file for details.
+
+---
+
+**Links:**
+- [AL-Go Repository](https://github.com/microsoft/AL-Go)
+- [Model Context Protocol](https://github.com/modelcontextprotocol)
+- [Business Central AL Development](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/devenv-dev-overview)

package/build/index.js

@@ -144,17 +144,17 @@ server.registerPrompt("al-go-setup-help", {
         scenario: z.string().optional().describe("Specific scenario or requirement")
     }
 }, ({ projectType, scenario }) => {
-    const basePrompt = `You are an expert in AL-Go for GitHub, Microsoft's development framework for Business Central extensions. Help the user set up an AL-Go project.
-
-Project Type: ${projectType}
-${scenario ? `Scenario: ${scenario}` : ''}
-
-Please provide step-by-step guidance including:
-1. Repository setup and structure
-2. Required configuration files
-3. Workflow configuration
-4. Best practices and common pitfalls
-
+    const basePrompt = `You are an expert in AL-Go for GitHub, Microsoft's development framework for Business Central extensions. Help the user set up an AL-Go project.
+
+Project Type: ${projectType}
+${scenario ? `Scenario: ${scenario}` : ''}
+
+Please provide step-by-step guidance including:
+1. Repository setup and structure
+2. Required configuration files
+3. Workflow configuration
+4. Best practices and common pitfalls
+
 Use the AL-Go documentation and examples available through the MCP tools to provide accurate, up-to-date information.`;
     return {
         messages: [{

package/package.json

@@ -1,38 +1,38 @@
-{
-  "name": "al-go-mcp-server",
-  "version": "1.0.0",
-  "description": "MCP server for AL-Go documentation integration",
-  "type": "module",
-  "main": "./build/index.js",
-  "bin": {
-    "al-go-mcp-server": "./build/index.js"
-  },
-  "scripts": {
-    "build": "tsc",
-    "start": "node build/index.js",
-    "dev": "tsc && node build/index.js",
-    "watch": "tsc --watch"
-  },
-  "keywords": [
-    "mcp",
-    "model-context-protocol",
-    "al-go",
-    "documentation",
-    "github"
-  ],
-  "author": "Job Louage",
-  "license": "MIT",
-  "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.18.0",
-    "@octokit/rest": "^21.0.2",
-    "zod": "^3.23.8",
-    "node-fetch": "^3.3.2"
-  },
-  "devDependencies": {
-    "@types/node": "^22.0.0",
-    "typescript": "^5.6.0"
-  },
-  "files": [
-    "build"
-  ]
-}
+{
+  "name": "al-go-mcp-server",
+  "version": "1.0.1",
+  "description": "MCP server for AL-Go documentation integration",
+  "type": "module",
+  "main": "./build/index.js",
+  "bin": {
+    "al-go-mcp-server": "build/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node build/index.js",
+    "dev": "tsc && node build/index.js",
+    "watch": "tsc --watch"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "al-go",
+    "documentation",
+    "github"
+  ],
+  "author": "Job Louage",
+  "license": "MIT",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.18.0",
+    "@octokit/rest": "^21.0.2",
+    "zod": "^3.23.8",
+    "node-fetch": "^3.3.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.6.0"
+  },
+  "files": [
+    "build"
+  ]
+}