Skip to content

Commit 89a7b66

Browse files
committed
Incorporated tech comments
1 parent c89dab0 commit 89a7b66

6 files changed

+40
-18
lines changed

artifacts/attributes.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,3 +168,6 @@
168168
:upgrading-book-title: Upgrading {product}
169169
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
170170
:using-dynamic-plugins-book-title: Using dynamic plugins
171+
172+
:model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index
173+
:model-context-protocol-title: Interacting with Model Context Protocol tools for {product}

modules/model-context-protocol-tools/con-understanding-model-context-protocol.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55

66
include::{docdir}/artifacts/snip-developer-preview.adoc[]
77

8-
The Model Context Protocol (MCP) server offers a standardized method for linking AI models and applications (MCP clients) with external systems. This connection facilitates access to information and workflows residing on those systems. MCP servers are responsible for defining the tools that AI applications can utilize to retrieve this data.
8+
Model Context Protocol (MCP) offers a standardized method for linking AI models and applications (MCP clients) with external systems. This connection facilitates access to information and workflows residing on those systems. MCP servers are responsible for defining the tools that AI applications can utilize to retrieve this data.
99

1010
{product} supports running MCP tools through the `mcp-actions-backend` plugin available in {backstage} 1.40 or later.

modules/model-context-protocol-tools/proc-configuring-mcp-clients-to-access-the-rhdh-server.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ Some clients do not yet support the Streamable endpoint, and you might need to u
3838
}
3939
}
4040
----
41-
+
41+
4242
where:
4343
`<MCP_TOKEN>`:: Previously configured static token
44-
`<RHDH_TOKEN>`:: Hostname of your {product-very-short} instance
44+
`<RHDH_HOST>`:: Hostname of your {product-very-short} instance
4545

4646
* Configure the *Continue* client.
4747
.. In your agent yaml configuration file, add the following configuration:
@@ -56,10 +56,10 @@ mcpServers:
5656
headers:
5757
Authorization: "Bearer <MCP_TOKEN>"
5858
----
59-
+
59+
6060
where:
6161
`<MCP_TOKEN>`:: Previously configured static token
62-
`<RHDH_TOKEN>`:: Hostname of your {product-very-short} instance
62+
`<RHDH_HOST>`:: Hostname of your {product-very-short} instance
6363

6464
* Configure the *Lightspeed Plugin/Lightspeed Core (LCS)* client.
6565
.. In the `lightspeed-stack.yaml` configuration, add the following configuration for `mcp_servers`:
@@ -71,9 +71,10 @@ mcp_servers:
7171
provider_id: model-context-protocol
7272
url: https://<RHDH_HOST>/api/mcp-actions/v1
7373
----
74-
+
74+
7575
where:
76-
`model-context-protocol`:: Enter this definition in your llama-stack `run.yaml` configuration for use in LCS.
76+
`model-context-protocol`:: This is the tool runtime provider defined and configured in the llama-stack `run.yaml` configuration for use in LCS.
77+
7778
.. Optional: If you want to use your own Llama Stack configuration, add the following code to your Llama Stack configuration file (`run.yaml`).
7879
+
7980
[source,yaml]
@@ -84,7 +85,7 @@ providers:
8485
provider_type: remote::model-context-protocol
8586
config: {}
8687
----
87-
.. Optional: To authorize requests to the MCP endpoint using `<MCP_TOKEN>`, add it in the `{ls-short} app-config.yaml` file, to make POST requests to the LCS `/v1/streaming_query` endpoint, as shown in the following code:
88+
.. To authorize requests to the MCP endpoint using `<MCP_TOKEN>`, add it in the `{ls-short} app-config.yaml` file, to make POST requests to the LCS `/v1/streaming_query` endpoint, as shown in the following code:
8889
+
8990
[source,yaml]
9091
----
@@ -103,6 +104,9 @@ curl -X POST \
103104
-d '{"query": "Can you give me all catalog templates of type 'service', "model": "gpt-4o-mini", "provider": "openai"}' \
104105
_<url>_/v1/streaming_query
105106
----
106-
+
107+
108+
where:
109+
`<url>`:: Enter the LCS endpoint. You can use localhost(<{product-very-short}_servicename>.<{product-very-short}-namespace>.svc.cluster.local:8080) or the service name for this field if you are inside the {backstage} container.
110+
107111
where:
108-
`<url>`:: Enter the LCS endooint. You can retrieve the LCS endpoint by using `curl` in the {backstage} container.
112+
`<url>`:: Specify the **LCS endpoint**. Use `localhost` (`127.0.0.1:8080`) or the service name if operating within the `{backstage}` container.

modules/model-context-protocol-tools/proc-configuring-model-context-protocol.adoc

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
You can enable your AI client applications to access {product-very-short} information and workflows. This configuration is a prerequisite for AI clients to use the defined MCP tools and leverage {product-very-short} data.
77

8+
.Prerequisite
9+
10+
* You have {model-context-protocol-link}#proc-installing-the-mcp-server-and-tool-plugins[installed the MCP server and tool plugins in {product}].
11+
812
.Procedure
913

1014
. In your `{product} app-config.yaml` file, configure a static token for authentication against the MCP server endpoint. MCP clients (such as `Cursor`, `Continue`, or `Lightspeed Core`) use these tokens to authenticate against the {backstage} MCP server. For example:
@@ -23,6 +27,17 @@ backend:
2327
where:
2428
`${MCP_TOKEN}`:: Set the token value that you generate.
2529

30+
[NOTE]
31+
====
32+
Tokens must be long and complex strings without whitespace to prevent brute-force guessing.
33+
34+
To generate a sample token, use the following command:
35+
[source,bash]
36+
----
37+
node -p 'require("crypto").randomBytes(24).toString("base64")'
38+
----
39+
====
40+
2641
. Register the MCP tools that you install as a plugin source, as shown in the following example:
2742
+
2843
[source,yaml]
@@ -56,7 +71,7 @@ backend:
5671
externalAccess:
5772
- type: static
5873
options:
59-
token: ${ADMIN_TOKEN}
74+
token: ${MCP_TOKEN}
6075
subject: mcp-clients
6176
keys:
6277
- secret: "${BACKEND_SECRET}"

modules/model-context-protocol-tools/proc-installing-the-mcp-server-and-tool-plugins.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ plugins:
2727
+
2828
[source,yaml]
2929
----
30-
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool:bs_1.42.5__0.1.2!red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool
30+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool:bs_1.42.5__0.2.3!red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool
3131
disabled: false
3232
----
3333
** To install the TechDocs MCP tool, in your dynamic plugins ConfigMap (for example, `dynamic-plugins-rhdh.yaml`), add the TechDocs MCP tool plugin as shown in the following example:
3434
+
3535
[source,yaml]
3636
----
37-
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-techdocs-mcp-tool:bs_1.42.5__0.1.2!red-hat-developer-hub-backstage-plugin-techdocs-mcp-tool
37+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-techdocs-mcp-tool:bs_1.42.5__0.3.0!red-hat-developer-hub-backstage-plugin-techdocs-mcp-tool
3838
disabled: false
3939
----

modules/model-context-protocol-tools/proc-verifying-successful-installation-of-mcp-plugins.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ oc logs -c install-dynamic-plugins deployment/<my-product-deployment>
2525
[source]
2626
----
2727
..... prior logs ....
28-
======= Installing dynamic plugin oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-mcp-actions-backend:next__0.2.0!backstage-plugin-mcp-actions-backend
28+
======= Installing dynamic plugin oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-mcp-actions-backend:bs_1.42.5__0.1.2!backstage-plugin-mcp-actions-backend
2929
==> Copying image oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-mcp-actions-backend:next__0.2.0 to local filesystem
30-
==> Successfully installed dynamic plugin oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-mcp-actions-backend:next__0.2.0!backstage-plugin-mcp-actions-backend
30+
==> Successfully installed dynamic plugin oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-mcp-actions-backend:bs_1.42.5__0.1.2!backstage-plugin-mcp-actions-backend
3131
----
3232
. You must see entries for any of the MCP tool plugins you installed as shown in the following code:
3333
+
3434
[source]
3535
----
3636
..... prior logs ....
37-
======= Installing dynamic plugin oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool:next__0.2.0!red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool
38-
==> Copying image oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool:next__0.2.0 to local filesystem
39-
==> Successfully installed dynamic plugin oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool:next__0.2.0!red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool
37+
======= Installing dynamic plugin oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool:bs_1.42.5__0.2.3!red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool
38+
==> Copying image oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool:bs_1.42.5__0.2.3!red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool to local filesystem
39+
==> Successfully installed dynamic plugin oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool:bs_1.42.5__0.2.3!red-hat-developer-hub-backstage-plugin-software-catalog-mcp-tool
4040
----

0 commit comments

Comments
 (0)