Validate an Office Add-in's manifest

Validate your add-in manifest before sideloading or publishing to catch schema and configuration issues early. This helps prevent errors such as "Your add-in manifest is not valid."

Unless noted otherwise, the methods in this article apply to both the unified manifest for Microsoft 365 and the add-in only manifest.

Choose a validation method

• If your project was created with Microsoft 365 Agents Toolkit or Yeoman generator for Office Add-ins (Yo Office), use Validate your manifest with the validate command.
• If your project wasn't created with Agents Toolkit or Yo Office, use Validate your manifest with office-addin-manifest.
• If you're using Agents Toolkit with the unified manifest, use Validate the manifest in the UI of Agents Toolkit.

Validate your manifest with the validate command

If you used Agents Toolkit or Yo Office to create your add-in, you can validate your project's manifest file with the following command in the root directory of your project.

npm run validate

Microsoft 365 and Copilot store validation

The validate command also does Microsoft 365 and Copilot store validation but allows developer information like localhost URLs. If you'd like to run production-level Microsoft 365 and Copilot store validation, then run the following command.

npm run validate -- -p

If you're having trouble with that command, try the following (replacing MANIFEST_FILE with the name of the manifest file).

npx office-addin-manifest validate -p MANIFEST_FILE

Validate your manifest with office-addin-manifest

If you didn't use Microsoft 365 Agents Toolkit or Yeoman generator for Office Add-ins to create your add-in, you can validate the manifest by using office-addin-manifest.

1. Install Node.js.

2. Open a command prompt and install the validator with the following command.

   npm install -g office-addin-manifest
   

3. Run the following command in the folder of your project that contains the manifest file (replacing MANIFEST_FILE with the name of the manifest file).

   office-addin-manifest validate MANIFEST_FILE
   

   Note

   If this command isn't working, run the following command instead to force the use of the latest version of the office-addin-manifest tool (replacing MANIFEST_FILE with the name of the manifest file).

   npx office-addin-manifest validate MANIFEST_FILE
   

Validate the manifest in the UI of Agents Toolkit

If you're working in Agents Toolkit and using the unified manifest, you can use the toolkit's validation options. For instructions, see Validate application.

See also

• Office Add-ins manifest
• Clear the Office cache
• Debug your add-in with runtime logging
• Sideload Office Add-ins for testing
• Debug add-ins using developer tools in Microsoft Edge