al-go

AL-Go MCP Server exposes a focused set of tools that index and expose AL-Go documentation and resources through the MCP interface. Once started (via npx al-go-mcp-server@latest or a similar npm-based invocation), you can access three core tools: search-al-go-docs for querying AL-Go documentation, get-al-go-workflows for retrieving example GitHub workflows from the AL-Go repository, and refresh-al-go-cache to force a cache refresh of documentation and resources. These tools are designed to be invoked from an MCP-enabled client or VS Code extension, allowing you to quickly locate guidance, templates, and repository contents without leaving your development environment. The server also supports optional GitHub authentication to increase rate limits when querying larger docs sets or accessing protected resources. It’s easy to run the server on-demand with npx, making it convenient for local development or quick tooling integration.

Prerequisites:

• Node.js (LTS) and npm installed on your machine
• Internet access to fetch packages from npm registry

Installation steps:

1. Install the MCP server globally via npm or use npx directly (no permanent install required):

# Option A: run directly with npx (no installation required)
npx --yes al-go-mcp-server@latest

2. If you prefer a local install (optional):

# Install globally (optional for CLI convenience)
npm install -g al-go-mcp-server

# Run locally from the project root (if you clone the repo)
npm install
npm run build
npm start

3. Verify installation by checking the version or starting the server as described in the repo:

npx --yes al-go-mcp-server@latest --version

Tips and common considerations:

• If you hit GitHub API rate limits, provide a GitHub token to increase quota. The token can be supplied in MCP client configurations via the GITHUB_TOKEN environment variable.
• The server caches documentation to improve performance; use refresh-al-go-cache to force a new crawl of the AL-Go repository when updates are expected.
• The npm-based approach (npx al-go-mcp-server@latest) always pulls the latest release, which is helpful for getting new features without manual upgrades.
• When integrating with the VS Code MCP extension, you can configure the server in user or project settings as shown in the README to enable seamless cross-project usage.
• Compatibility: designed to work with standard MCP clients and the AL-Go documentation surface; ensure your client supports the three tools: search-al-go-docs, get-al-go-workflows, refresh-al-go-cache.