Skip to content

Commit da41cc1

Browse files
committed
Incorporated Ben's comments
1 parent c7ce962 commit da41cc1

5 files changed

+10
-28
lines changed

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-mcp.adoc[]
77

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.
8+
*Model Context Protocol* (*MCP*) offers a standardized method for linking AI models and applications (*MCP clients*) with external systems (*MCP servers*). This connection facilitates access to information and workflows residing on those systems. *MCP servers* are responsible for defining the tools that MCP clients can interact with.
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-accessing-and-analyzing-doc-using-techdocs-mcp-tools.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[id="proc-accessing-and-analyzing-doc-using-techdocs-mcp-tools_{context}"]
44
= Accessing and analyzing documentation using the TechDocs MCP tools
55

6-
The TechDocs Model Context Protocol (MCP) tool enables AI clients to search and retrieve documentation directly from {product-very-short} TechDocs instances. Use this tool to query documentation content and integrate it as context into your AI applications.
6+
The TechDocs MCP tool enables MCP clients to search and retrieve documentation directly from TechDocs registered in your {product-very-short} instance. Use this tool to query documentation content and integrate it as context into your AI applications.
77

88
The following TechDocs MCP tools are supported:
99
* `fetch-techdocs`

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

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[id="proc-configuring-mpc-clients-to-access-the-rhdh-server_{context}"]
44
= Configuring MCP clients to access the {product-very-short} server
55

6-
You must configure an MCP client to interact with the MCP server. For more information on the list of clients and their respective configurations, see https://modelcontextprotocol.io/clients[Example Clients].
6+
You must configure an MCP client before it can interact with the MCP server. For more information on the list of clients and their respective configurations, see https://modelcontextprotocol.io/clients[Example Clients].
77

88
.Prerequisites
99

@@ -17,27 +17,9 @@ You must configure an MCP client to interact with the MCP server. For more infor
1717
Some clients do not yet support the Streamable endpoint, and you might need to use the SSE endpoint instead.
1818
====
1919

20-
.Procedure
20+
* You have set the ${MCP_TOKEN} in your MCP server configuration as the bearer token when authenticating with the MCP server.
2121

22-
. Set the ${MCP_TOKEN} in your MCP server configuration as the bearer token when authenticating with the MCP server by completing the following steps:
23-
.. In the {ocp-short} web console, go to *Secrets*.
24-
.. Click *Create > Key/value secret*.
25-
.. In the *Create key/value secret* page, select the *YAML view* option in *Configure via*, and add the following example:
26-
+
27-
[source,yaml]
28-
----
29-
kind: Secret
30-
apiVersion: v1
31-
metadata:
32-
name: MCP_TOKEN
33-
namespace: _<namespace>_ #
34-
stringData:
35-
LLM_SERVER_ID: _<server_id>_
36-
LLM_SERVER_TOKEN: _<token>_
37-
LLM_SERVER_URL: _<server_url>_
38-
type: Opaque
39-
----
40-
.. Click *Create*.
22+
.Procedure
4123

4224
. Configure the *Cursor* client.
4325
.. From your Desktop app, navigate to *Cursor Settings* and select *MCP Tools > New MCP Server*.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[id="proc-configuring-model-context-protocol_{context}"]
44
= Configuring Model Context Protocol in {product}
55

6-
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.
6+
You can enable your MCP client applications to use the MCP protocol to access {product-very-short} information and workflows. This configuration is a prerequisite for MCP clients to use the defined MCP tools and access the exposed capabilities of {product-very-short}.
77

88
.Prerequisite
99

@@ -25,7 +25,7 @@ backend:
2525
----
2626
where:
2727

28-
`${MCP_TOKEN}`:: Set the token value that you generate.
28+
`${MCP_TOKEN}`:: Set the token value that you generate manually and share with your MCP clients
2929
+
3030
[NOTE]
3131
====
@@ -49,7 +49,7 @@ backend:
4949
- techdocs-mcp-tool
5050
----
5151
+
52-
.`{my-app-config-file}` file with MCP configuration example
52+
.Full `{my-app-config-file}` file example with MCP configuration
5353
[source,yaml,subs="+attributes,+quotes"]
5454
----
5555
app:

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
@@ -5,8 +5,8 @@
55

66
To enable MCP support in {product}, you need to install the following components:
77

8-
Backend MCP server plugin:: Runs the MCP tools.
9-
MCP tool plugins:: Facilitates integration with the Software Catalog and TechDocs.
8+
Backend MCP server plugin:: Responsible for running MCP tools.
9+
MCP tool plugins:: Individual MCP plugins that expose capabilities relating to the Software Catalog and TechDocs features in {product-very-short}.
1010

1111
.Prerequisites
1212

0 commit comments

Comments
 (0)