Skip to content

Commit 2721b75

Browse files
[release-1.10] RHIDP-13661: MCP JTBD implementation (#2225)
* MCP JTBD implementation * MAysun's content update * Incorporated Maysun's comments --------- Co-authored-by: Priyanka Abel <pabel@redhat.com>
1 parent 9f9172e commit 2721b75

8 files changed

Lines changed: 36 additions & 36 deletions

assemblies/integrate_interacting-with-model-context-protocol-tools-for-rhdh/assembly-configure-and-manage-mcp-settings.adoc

Lines changed: 0 additions & 16 deletions
This file was deleted.

assemblies/integrate_interacting-with-model-context-protocol-tools-for-rhdh/assembly-install-the-mcp-server-and-tool-plugins-in-rhdh.adoc renamed to assemblies/integrate_interacting-with-model-context-protocol-tools-for-rhdh/assembly-install-mcp-server-and-tool-plugins-to-expose-portal-capabilities-to-the-ai.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
:_mod-docs-content-type: ASSEMBLY
22
ifdef::context[:parent-context: {context}]
33

4-
[id="install-the-mcp-server-and-tool-plugins-in-rhdh_{context}"]
5-
= Install the MCP server and tool plugins in {product}
4+
[id="install-mcp-server-and-tool-plugins-to-expose-portal-capabilities-to-the-ai_{context}"]
5+
= Install MCP server and tool plugins to expose portal capabilities to the AI
66
:context: install-the-mcp-server-and-tool-plugins-in-rhdh
77

88
[role="_abstract"]
9-
As an administrator, you can enable Model Context Protocol (MCP) support in {product} by installing the backend server and tool plugins.
9+
Install the Model Context Protocol (MCP) server and its associated tool plugins to expose {product} portal capabilities, such as the Software Catalog and TechDocs, to your external AI assistant.
1010

1111
The backend MCP server plugin runs the MCP tools, while the individual tool plugins expose specific capabilities for the Software Catalog, TechDocs, and Scaffolder features.
1212

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
3+
4+
[id="store-personal-access-tokens-securely-to-authorize-ai-workflows-on-your-behalf_{context}"]
5+
= Store personal access tokens securely to authorize AI workflows on your behalf
6+
:context: store-personal-access-tokens-securely-to-authorize-ai-workflows-on-your-behalf
7+
8+
[role="_abstract"]
9+
When using third-party MCP integrations, you can store your personal access tokens securely and manage credentials in {ls-brand-name} so that the AI acts on your behalf.
10+
11+
include::../modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-enable-encryption-and-database-storage-for-mcp-server-tokens.adoc[leveloffset=+1]
12+
13+
include::../modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-toggle-mcp-tools-in-the-chat-interface-to-control-the-data-context-provided-to-the-ai.adoc[leveloffset=+1]
14+
15+
ifdef::parent-context[:context: {parent-context}]
16+
ifndef::parent-context[:!context:]

modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-configure-model-context-protocol-in-rhdh.adoc renamed to modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-configure-mcp-tokens-and-endpoints-to-authorize-client-access.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
:_mod-docs-content-type: PROCEDURE
22

3-
[id="configure-model-context-protocol-in-rhdh_{context}"]
4-
= Configure Model Context Protocol in {product}
3+
[id="configure-mcp-tokens-and-endpoints-to-authorize-client-access_{context}"]
4+
= Configure MCP tokens and endpoints to authorize client access
55

66
[role="_abstract"]
7-
Enable MCP client applications to access {product-very-short} information and workflows by configuring authentication tokens and server endpoints.
7+
Configure Model Context Protocol (MCP) server endpoints, database backends, and authentication tokens to securely authorize client applications to interact with your developer portal.
88

99
This configuration is a prerequisite for MCP clients to use the defined MCP tools and access the exposed capabilities of {product-very-short}.
1010

modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-manage-mcp-settings-in-the-user-interface.adoc renamed to modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-toggle-mcp-tools-in-the-chat-interface-to-control-the-data-context-provided-to-the-ai.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
:_mod-docs-content-type: PROCEDURE
22

3-
[id="manage-mcp-settings-in-the-user-interface_{context}"]
4-
= Manage MCP settings in the user interface
3+
[id="toggle-mcp-tools-in-the-chat-interface-to-control-the-data-context-provided-to-the-ai_{context}"]
4+
= Toggle MCP tools in the chat interface to control the data context provided to the AI
55

66
[role="_abstract"]
7-
To customize the tools and data sources available in the {ls-brand-name} chat interface, you can manage Model Context Protocol (MCP) server connections and personal authentication tokens.
7+
Use the {ls-brand-name} chat interface options to securely configure your personal tokens, toggle specific Model Context Protocol (MCP) services, and directly control the data context made available to the AI assistant.
88

99
You can use the *MCP settings* panel in the {ls-short} chat interface to review server status and enable or disable specific tools for your session.
1010

modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-access-rhdh-data-using-the-software-catalog-mcp-tools.adoc renamed to modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-enable-software-catalog-mcp-tools-to-allow-the-ai-to-query-component-metadata.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
:_mod-docs-content-type: REFERENCE
22

3-
[id="access-rhdh-data-using-the-software-catalog-mcp-tools_{context}"]
4-
= Access {product-very-short} data using the Software Catalog MCP tools
3+
[id="enable-software-catalog-mcp-tools-to-allow-the-ai-to-query-component-metadata_{context}"]
4+
= Enable Software Catalog MCP tools to allow the AI to query component metadata
55

66
[role="_abstract"]
7-
Manage and retrieve Software Catalog entities including Components, Systems, Resources, APIs, Locations, Users, and Groups using MCP tools.
7+
Enable and use the Software Catalog MCP tools so that the AI assistant can seamlessly query internal software component metadata, relations, and ownership information on your behalf.
88

99
Use Software Catalog MCP tools to manage and retrieve {product-very-short} entities such as *Components*, *Systems*, *Resources*, *APIs*, *Locations*, *Users*, and *Groups*.
1010

modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-access-and-analyze-documentation-using-the-techdocs-mcp-tools.adoc renamed to modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-enable-techdocs-mcp-tools-to-allow-the-ai-to-read-and-analyze-internal-documentation.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
:_mod-docs-content-type: REFERENCE
22

3-
[id="access-and-analyze-documentation-using-the-techdocs-mcp-tools_{context}"]
4-
= Access and analyze documentation using the TechDocs MCP tools
3+
[id="enable-techdocs-mcp-tools-to-allow-the-ai-to-read-and-analyze-internal-documentation_{context}"]
4+
= Enable TechDocs MCP tools to allow the AI to read and analyze internal documentation
55

66
[role="_abstract"]
7-
Use TechDocs MCP tools to search, retrieve, and analyze documentation content from {product-short} for AI applications.
7+
Enable and use TechDocs MCP tools to allow the AI assistant to search, read, and analyze your internal technical documentation to resolve queries with accurate portal data.
88

99
The TechDocs MCP tool enables MCP clients to search and retrieve documentation from {product-very-short} for use as context in AI applications.
1010

titles/integrate_interacting-with-model-context-protocol-tools-for-rhdh/master.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ include::artifacts/attributes.adoc[]
1616

1717
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/con-model-context-protocol.adoc[leveloffset=+1]
1818

19-
include::assemblies/integrate_interacting-with-model-context-protocol-tools-for-rhdh/assembly-install-the-mcp-server-and-tool-plugins-in-rhdh.adoc[leveloffset=+1]
19+
include::assemblies/integrate_interacting-with-model-context-protocol-tools-for-rhdh/assembly-install-mcp-server-and-tool-plugins-to-expose-portal-capabilities-to-the-ai.adoc[leveloffset=+1]
2020

21-
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-configure-model-context-protocol-in-rhdh.adoc[leveloffset=+1]
21+
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-configure-mcp-tokens-and-endpoints-to-authorize-client-access.adoc[leveloffset=+1]
2222

2323
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/proc-configure-mcp-clients-to-access-the-rhdh-server.adoc[leveloffset=+2]
2424

25-
include::assemblies/integrate_interacting-with-model-context-protocol-tools-for-rhdh/assembly-configure-and-manage-mcp-settings.adoc[leveloffset=+1]
25+
include::assemblies/integrate_interacting-with-model-context-protocol-tools-for-rhdh/assembly-store-personal-access-tokens-securely-to-authorize-ai-workflows-on-your-behalf.adoc[leveloffset=+1]
2626

27-
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-access-rhdh-data-using-the-software-catalog-mcp-tools.adoc[leveloffset=+1]
27+
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-enable-software-catalog-mcp-tools-to-allow-the-ai-to-query-component-metadata.adoc[leveloffset=+1]
2828

2929
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-fetch-entities-using-fetch-catalog-entities.adoc[leveloffset=+2]
3030

@@ -34,7 +34,7 @@ include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhd
3434

3535
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-retrieve-software-template-metadata.adoc[leveloffset=+2]
3636

37-
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-access-and-analyze-documentation-using-the-techdocs-mcp-tools.adoc[leveloffset=+1]
37+
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-enable-techdocs-mcp-tools-to-allow-the-ai-to-read-and-analyze-internal-documentation.adoc[leveloffset=+1]
3838

3939
include::modules/integrate_interacting-with-model-context-protocol-tools-for-rhdh/ref-retrieve-techdocs-urls-and-metadata-using-fetch-techdocs.adoc[leveloffset=+2]
4040

0 commit comments

Comments
 (0)