AI agents: use the documentation index at llms.txt to locate machine-readable pages. This section is indexed by https://docs.particular.net/nservicebus/llms.txt. The markdown version of this page is served as plain text. An MCP server at /mcp serves the same content via the search_docs and read_doc tools; it is read-only and needs no credentials. Markdown versions of documentation pages are available by appending .md to the page URL. Directory URLs use index.md. They are served as text/plain because some retrieval backends reject text/markdown.

Tool and Helper Changes in NServiceBus Version 6

This is part of the NServiceBus Upgrade Guide from Version 5 to 6, which also includes the following individual upgrade guides for specific components:

Feature Details
Transports
Persistence
Hosting
Other

Visual Studio PowerShell helpers removed

In NServiceBus versions 3 through 5, there is a NuGet package that provides helpers to generate XML configuration sections using the PowerShell console in Visual Studio.

For example, running the Add-NServiceBusAuditConfig ProjectName command would add the following section to the app.config file:

<configuration>
  <configSections>
    <section name="AuditConfig"
             type="NServiceBus.Config.AuditConfig, NServiceBus.Core" />
  </configSections>
  <AuditConfig QueueName="audit" />
</configuration>

These helpers have been removed in version 6. The configuration helpers encouraged creating a more complex XML configuration than was necessary, making it difficult to manage in the long run.

The recommended configuration approach is "code-first", which is more flexible and less error-prone than using the PowerShell helpers. The configuration can be read from any location at runtime, including the app.config. For more information about the API, refer to the configuration documentation dedicated to the particular functionality. For example, see how recoverability and audit queues can be configured using code API.

MSMQ ReturnToSourceQueue.exe

The MSMQ ReturnToSourceQueue.exe tool is deprecated. The code for this tool has been moved to ParticularLabs/MsmqReturnToSourceQueue. See the readme in that repository for full details.

In this article