AI agents: use the documentation index at llms.txt to locate machine-readable pages. This section is indexed by https://docs.particular.net/serviceinsight/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.

ServiceInsight Application Invocation

Component:
ServiceInsight

It is possible to load any given message in ServiceInsight by navigating to a URI that ServiceInsight listens to:

si://localhost:33333/api?search=487b5055-11bb-4a70-a4fd-a2c00125aa43

This launches ServiceInsight and does the following:

  • Automatically connects to localhost on port 33333
  • Performs a search on a specific Message ID

This means that a specific message that was in the error queue will be displayed as soon ServiceInsight opens, allowing the cause to be seen.

The URI can be generated manually as long as the convention is followed. Construct the URI and send it to the development team, who can then paste it into the Run window or a browser.

A list of the supported parameters and a description of their effects:

  • Search [String]: Performs a search using the full-text search feature of ServiceInsight. This can be a message identifier, a part of the message payload, or any value in the message header.
  • Example: si://localhost:33333/api?search=SubmitOrder
  • EndpointName [String]: The name of the endpoint to select upon startup. When an endpoint is selected, the operations and message lists are filtered to the endpoint.
  • Example: si://localhost:33333/api?EndpointName=VideoStore.Sales&search=SubmitOrder
  • AutoRefresh [Integer]: Turns on the AutoRefresh option so that the view is refreshed, based on the value provided here (in seconds).
  • Example: si://localhost:33333/api?EndpointName=VideoStore.Sales&search=SubmitOrder&Auto&AutoRefresh=5
  • SilentStartup [Boolean]: When set to true, the splash screen will not show when launching the application.

When ServiceInsight is launched using these parameters, notice the effects on the user interface (having the endpoint selected, message selected, etc.). If a passed-in argument is not supported, ServiceInsight will notify when it runs.

In this article