diff --git a/assemblies/assembly-model-context-protocol-tools.adoc b/assemblies/assembly-model-context-protocol-tools.adoc index b37fe209b5..9c6e8958fd 100644 --- a/assemblies/assembly-model-context-protocol-tools.adoc +++ b/assemblies/assembly-model-context-protocol-tools.adoc @@ -12,8 +12,6 @@ include::modules/model-context-protocol-tools/proc-configuring-model-context-pro include::modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc[leveloffset=+2] -include::modules/model-context-protocol-tools/proc-configuring-mcp-tools-for-developer-lightspeed.adoc[leveloffset=+1] - include::assembly-using-the-mcp-tools-to-access-data.adoc[leveloffset=+1] include::assembly-troubleshooting-mcp-server-and-client-problems.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc b/modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc index d47a28cc98..c90f71d291 100644 --- a/modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc +++ b/modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc @@ -21,16 +21,16 @@ Some clients do not yet support the Streamable endpoint, and you might need to u .Procedure -. Configure the *Cursor* client. +. Configure *Cursor* as a client. .. From your Desktop app, navigate to *Cursor Settings* and select *MCP Tools > New MCP Server*. .. Add the following configuration: + -[source,yaml,subs="+attributes,+quotes"] +[source,yaml] ---- { "mcpServers": { "backstage-actions": { - "url": "https://<{product-very-short}_HOST>/api/mcp-actions/v1", + "url": "https:///api/mcp-actions/v1", "headers": { "Authorization": "Bearer " } @@ -41,9 +41,9 @@ Some clients do not yet support the Streamable endpoint, and you might need to u where: ``:: Enter the previously configured static token -`<{product-very-short}_HOST>`:: Enter the hostname of your {product-very-short} instance +``:: Enter the hostname of your {product-very-short} instance -. Configure the *Continue* client. +. Configure *Continue* as a client. .. In your agent yaml configuration file, add the following configuration: + @@ -52,7 +52,7 @@ where: mcpServers: - name: backstage-actions type: sse - url: https://<{product-very-short}_HOST>/api/mcp-actions/v1/sse + url: https:///api/mcp-actions/v1/sse requestOptions: headers: Authorization: "Bearer " @@ -61,9 +61,9 @@ mcpServers: where: ``:: Enter the previously configured static token -`<{product-very-short}_HOST>`:: Enter the hostname of your {product-very-short} instance +``:: Enter the hostname of your {product-very-short} instance -. Configure the *Lightspeed Plugin/Lightspeed Core (LCS)* client. +. Configure *{ls-short}* as a client. For more details, see {developer-lightspeed-link}[{ls-brand-name}]. .. In the `lightspeed-stack.yaml` configuration, add the following configuration for `mcp_servers`: + [source,yaml,subs="+attributes,+quotes"] @@ -87,7 +87,7 @@ providers: provider_type: remote::model-context-protocol config: {} ---- -.. To authorize requests to the MCP endpoint using ``, add it in the {ls-short} {my-app-config-file}` file, to make POST requests to the LCS `/v1/streaming_query` endpoint, as shown in the following code: +.. To authorize requests to the MCP endpoint using ``, add it in the {ls-short} `{my-app-config-file}` file, to make POST requests to LCS, as shown in the following code: + [source,yaml] ---- diff --git a/modules/model-context-protocol-tools/proc-configuring-mcp-tools-for-developer-lightspeed.adoc b/modules/model-context-protocol-tools/proc-configuring-mcp-tools-for-developer-lightspeed.adoc deleted file mode 100644 index 026b7f0027..0000000000 --- a/modules/model-context-protocol-tools/proc-configuring-mcp-tools-for-developer-lightspeed.adoc +++ /dev/null @@ -1,65 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="proc-configure-mcp-tools-for-developer-lightspeed_{context}"] -= Configuring the {product-very-short} Model Context Protocol (MCP) tools for {ls-short} (Optional) - -To leverage Model Context Protocol (MCP) servers like, the {model-context-protocol-link}[server in {product-very-short} with {ls-short}], you must first integrate them into the Llama Stack service. Configuring MCP in {lcs-short} enables the deployed {lcs-short} and Llama Stack to use external tools and retrieve real-time data. This integration allows the virtual assistant to execute complex actions and incorporate current operational context into its responses. - -Configuration requires synchronizing settings across three components: the Llama Stack tool definition, the {lcs-short} MCP server endpoint definition, and the {ls-brand-name} plugin MCP authorization token. - -For more information on configuring {ls-short}, see {developer-lightspeed-link}#proc-installing-and-configuring-lightspeed_developer-lightspeed[Installing and configuring {ls-brand-name}]. - -.Prerequisites - -* You have configured {model-context-protocol-link}[MCP tools in your {product} instance]. - -.Procedure -. Configure the Llama Stack tool definition by defining the MCP provider in the `tool_runtime` section of the Llama Stack configuration file (`run.yaml`), as shown in the following code: -+ -[source,yaml] ----- -providers: - tool_runtime: - - provider_id: model-context-protocol - provider_type: remote::model-context-protocol - config: {} ----- - -. Configure the {lcs-short} MCP server endpoint by defining the MCP server endpoints in the {lcs-short} configuration file (`lightspeed-stack.yaml`), as shown in the following code: -+ -[source,yaml] ----- -mcp_servers: - - name: mcp::backstage - provider_id: model-context-protocol - url: https:///api/mcp-actions/v1 ----- - -where: - -``:: Hostname of your {product-very-short} instance -+ -[IMPORTANT] -==== -`provider_id` must match the Llama Stack definition (`model-context-protocol`). -==== - -. Configure the {ls-brand-name} plugin authorization token by specifying the MCP servers and providing the token for authentication in the {ls-brand-name} plugin configuration file (`lightspeed-app-config.yaml`), as shown in the following code: -+ -[source,yaml] ----- -lightspeed: - mcpServers: - - name: mcp::backstage - token: ${MCP_TOKEN} ----- -+ -[IMPORTANT] -==== -`name` must match the {lcs-name} definition (`mcp::backstage`). -==== - -[NOTE] -==== -Self-hosted models might provide inconsistent or poor performance when using tool calling features, such as the Model Context Protocol (MCP). It is recommended to use the latest foundation models from providers like `OpenAI`` when experimenting with this integration to ensure the most reliable functionality. -==== \ No newline at end of file