{"title":"Download AL symbol packages - aldownloadsymbols","url":"https://jonas-paprotka.de/docs/dev-itpro/developer/al-agent-tools/al-tool-download-symbols/","by":"JOP-AL","license":"Copyright (c) Microsoft Corporation. CC BY 4.0, https://creativecommons.org/licenses/by/4.0/; code samples MIT. From https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/al-agent-tools/al-tool-download-symbols, MicrosoftDocs/dynamics365smb-devitpro-pb at 828b6ee (2026-11-19). Changed: includes filled in, links to this site, and for agents shortened without dropping a fact.","credit":"Microsoft Corporation, CC BY 4.0","origin":"https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/al-agent-tools/al-tool-download-symbols","source":{"name":"Business Central developer and IT pro docs","repo":"https://github.com/MicrosoftDocs/dynamics365smb-devitpro-pb","commit":"828b6ee72fcd75755627cd6011f3d20899217ab2","date":"2026-11-19"},"checked":"2026-11-19","description":"Learn about the al_downloadsymbols tool available for AL development, including how to use it in Visual Studio Code with GitHub Copilot and through the AL MCP Server for headless environments and CI/CD pipelines.","date":"2026-10-02","meta":{"topic":"concept-article"},"outline":[{"level":1,"title":"Download AL symbol packages - al_downloadsymbols","slug":"download-al-symbol-packages---al_downloadsymbols","at":0,"chars":4912},{"level":2,"title":"Parameters","slug":"parameters","at":921,"chars":2203},{"level":3,"title":"Visual Studio Code","slug":"visual-studio-code","at":935,"chars":314},{"level":3,"title":"AL MCP Server","slug":"al-mcp-server","at":1249,"chars":1875},{"level":2,"title":"Symbols storage","slug":"symbols-storage","at":3124,"chars":186},{"level":2,"title":"Examples","slug":"examples","at":3310,"chars":824},{"level":3,"title":"Download symbols from a connected BC server (Visual Studio Code)","slug":"download-symbols-from-a-connected-bc-server-visual-studio-code","at":3322,"chars":206},{"level":3,"title":"Download symbols from global sources only (offline / CI)","slug":"download-symbols-from-global-sources-only-offline-ci","at":3528,"chars":348},{"level":3,"title":"Force re-download of all symbols (AL MCP)","slug":"force-re-download-of-all-symbols-al-mcp","at":3876,"chars":78},{"level":3,"title":"Download symbols for a specific project (AL MCP)","slug":"download-symbols-for-a-specific-project-al-mcp","at":3954,"chars":180},{"level":2,"title":"Suggested next steps","slug":"suggested-next-steps","at":4134,"chars":262},{"level":2,"title":"Related tools","slug":"related-tools","at":4396,"chars":406},{"level":2,"title":"Related information","slug":"related-information","at":4802,"chars":110}],"text":"# Download AL symbol packages - al_downloadsymbols\nApplies to: AL Language extension 17.0 and later | Available in: Visual Studio Code, AL MCP Server\nThe al_downloadsymbols tool downloads dependent `.app` symbol packages that AL compilation requires. Symbol packages contain the type information for objects defined in other extensions and in the Business Central base application.\nRun this tool before building or compiling if you encounter \"symbol not found\" errors, if you have added new dependencies to app.json, or if you want to refresh symbols to pick up updates from a connected Business Central environment.\nIn Visual Studio Code, connection details are read from the active launch.json configuration. In AL MCP, you can pass connection parameters directly or let the tool read from the workspace configuration.\nAfter a successful download, the workspace is automatically reloaded to refresh compilation caches.\n## Parameters\n### Visual Studio Code\nParameter|Type|Default|Description\nglobalSourcesOnly|boolean|false|When true, downloads symbols only from global sources (Microsoft NuGet feeds and AppSource). No Business Central server connection or authentication is required. Useful in CI environments without access to a live BC server.\n### AL MCP Server\nParameter|Type|Default|Description\nprojectPath|string|First project in workspace|Absolute path to the AL project folder containing app.json and launch.json.\nglobalSourcesOnly|boolean|false|When true, downloads symbols only from Microsoft NuGet feeds and AppSource. No server connection or authentication is required.\nforce|boolean|false|When true, re-downloads all symbol packages even if they're already cached locally.\nnoCache|boolean|false|When true, bypasses the authentication token cache and forces a new sign-in.\nuseInteractiveLogin|boolean|true|When true, opens a browser window for Microsoft Entra ID sign-in if authentication is required.\nenvironmentName|string|-|Cloud environment name (for example, `\"sandbox\"` or `\"production\"`). Overrides launch.json.\nenvironmentType|string|-|`\"Sandbox\"` or `\"Production\"`. Overrides launch.json.\ntenant|string|-|Microsoft Entra tenant ID or domain. Overrides launch.json.\nserverUrl|string|-|On-premises server URL (for example, `\"http://myserver\"`). Overrides launch.json.\nserverInstance|string|-|On-premises server instance name (for example, `\"BC\"`). Overrides launch.json.\nport|integer|-|Development service port. Overrides launch.json.\nauthentication|string|`\"AAD\"`|Authentication method: `\"AAD\"`, `\"Windows\"`, or `\"UserPassword\"`.\nenforceMinorVersion|boolean|false|The tool first selects the exact requested version when it's available. If the exact version isn't available and this parameter is true, the tool selects the highest available version with the same major and minor version for non-platform packages. For platform symbol references, the tool ignores this parameter and falls back to the highest available version with the same major version. If the exact version isn't available and this parameter is false, the tool falls back to the highest available version with the same major version.\n## Symbols storage\nDownloaded symbols are saved to the `.alpackages` folder inside the project directory. This folder is used automatically by the AL compiler when you build or compile.\n## Examples\n### Download symbols from a connected BC server (Visual Studio Code)\nIn Copilot Chat, say: \"Download symbols for my project.\"\nCopilot calls al_downloadsymbols. Connection details are read from launch.json.\n### Download symbols from global sources only (offline / CI)\nThis mode doesn't require a Business Central server connection. It downloads the Microsoft platform and base application symbols from Microsoft NuGet feeds and AppSource.\nVisual Studio Code:\n```json\n{\n  \"globalSourcesOnly\": true\n}\n```\nAL MCP:\n```json\n{\n  \"globalSourcesOnly\": true\n}\n```\n### Force re-download of all symbols (AL MCP)\n```json\n{\n  \"force\": true\n}\n```\n### Download symbols for a specific project (AL MCP)\n```json\n{\n  \"projectPath\": \"C:/repos/MyExtension\",\n  \"environmentName\": \"sandbox\",\n  \"tenant\": \"contoso.onmicrosoft.com\"\n}\n```\n## Suggested next steps\nOutcome|Suggested action\nDownload succeeded|Run al_build<al-tool-build> or al_compile<al-tool-compile> to compile the project.\nAuthentication error|Run al_auth_login<al-tool-auth#al_auth_login> (AL MCP) and retry, or set `noCache: true`.\n## Related tools\n al_build<al-tool-build> - Build the project after downloading symbols.\n al_compile<al-tool-compile> - Validate code after downloading symbols (AL MCP only).\n al_getpackagedependencies<al-tool-get-package-dependencies> - List the dependencies defined in app.json (AL MCP only).\n al_auth_login<al-tool-auth#al_auth_login> - Authenticate before downloading symbols from a cloud environment.\n## Related information\nAI agent tools overview<al-agent-tools-overview>\nAL MCP Server reference<al-mcp-server>"}