Skip to content

Commit 5c0975f

Browse files
committed
Incorporating Judy's comments
1 parent 250204e commit 5c0975f

9 files changed

+71
-56
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:previouscontext: {context}
3+
:context: proc-resolving-common-problems-with-mcp-clients-and-tools
4+
5+
[id="{context}"]
6+
= Provisioning and using your custom {product} configuration
7+
8+
The following procedures guide you through resolving common issues when using a Model Communication Protocol (MCP) client for tool calling.
9+
10+
include::modules/model-context-protocol-tools/proc-resolving-the-model-does-not-support-tool-calling-error.adoc[leveloffset=+1]
11+
12+
include::modules/model-context-protocol-tools/proc-resolving-authentication-issues-when-tool-are-not-found.adoc[leveloffset=+1]
13+
14+
include::modules/model-context-protocol-tools/proc-nonsensical-mcp-tool-output.adoc[leveloffset=+1]

assemblies/assembly-troubleshooting-mcp-server-and-client-problems.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ include::modules/model-context-protocol-tools/proc-checking-logs-for-mcp-tool-ex
1010

1111
include::modules/model-context-protocol-tools/con-understand-and-respond-to-mcp-tool-error-messages.adoc[leveloffset=+1]
1212

13-
include::modules/model-context-protocol-tools/proc-resolving-common-problems-with-mcp-clients-and-tools.adoc[leveloffset=+1]
13+
include::assembly-resolving-common-problems-with-mcp-clients-and-tools.adoc[leveloffset=+1]

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ You must configure an MCP client to interact with the MCP server. For more infor
77

88
.Prerequisites
99

10-
* You have configured one of the following endpoints as the server URL, where `<RHDH_HOST>` is the hostname of your {product-very-short} instance.
10+
* You have configured one of the following endpoints as the server URL, where `<{product-very-short}_HOST>` is the hostname of your {product-very-short} instance.
1111

12-
** Streamable: https://<RHDH_HOST>/api/mcp-actions/v1
13-
** SSE (Legacy): https://<RHDH_HOST>/api/mcp-actions/v1/sse
12+
** Streamable: https://<{product-very-short}_HOST>/api/mcp-actions/v1
13+
** SSE (Legacy): https://<{product-very-short}_HOST>/api/mcp-actions/v1/sse
1414
+
1515
[NOTE]
1616
====
@@ -21,7 +21,7 @@ Some clients do not yet support the Streamable endpoint, and you might need to u
2121

2222
. Set the ${MCP_TOKEN} in your MCP server configuration as the bearer token when authenticating with the MCP server by completing the following steps:
2323
.. In the {ocp-short} web console, go to *Secrets*.
24-
.. Click *Create > Key/value secret*.*
24+
.. Click *Create > Key/value secret*.
2525
.. In the *Create key/value secret* page, select the *YAML view* option in *Configure via*, and add the following example:
2626
+
2727
[source,yaml]
@@ -37,17 +37,18 @@ stringData:
3737
LLM_SERVER_URL: _<server_url>_
3838
type: Opaque
3939
----
40+
.. Click *Create*.
4041

4142
* Configure the *Cursor* client.
4243
.. From your Desktop app, navigate to `Cursor Settings` and select `MCP Tools > New MCP Server`.
4344
.. Add the following configuration:
4445
+
45-
[source,yaml]
46+
[source,yaml,subs="+attributes,+quotes"]
4647
----
4748
{
4849
"mcpServers": {
4950
"backstage-actions": {
50-
"url": "https://<RHDH_HOST>/api/mcp-actions/v1",
51+
"url": "https://<{product-very-short}_HOST>/api/mcp-actions/v1",
5152
"headers": {
5253
"Authorization": "Bearer <MCP_TOKEN>"
5354
}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="proc-nonsensical-mcp-tool-output.adoc_{context}"]
4+
= Resolve nonsensical MCP tool output
5+
6+
Nonsensical output often occurs when smaller models or models with smaller context sizes cannot effectively manage repeated tool calls within the same context window.
7+
8+
.Procedure
9+
10+
To improve the quality of the tool output, take the following actions:
11+
12+
. Select an appropriate model for tool calling.
13+
.. Verify that the model has good support for tool calling.
14+
.. Make sure your model is not too small. We recommend a model with at least 7 billion parameters and a context window of 32k.
15+
. Refine your queries.
16+
.. Use more well-defined queries that limit the amount of data returned in the response from the tool.
17+
. If possible, increase the context window size of the model. We recommend at least 32k for these MCP tools.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="proc-resolving-authentication-issues-when-tool-are-not-found.adoc_{context}"]
4+
= Resolving authentication issues when tools are not found
5+
6+
If your MCP client connects to the server but cannot find deployed tools, an authentication or configuration issue is likely.
7+
8+
.Procedure
9+
10+
. Verify the authentication token.
11+
.. Configure a static token for the RHDH MCP server.
12+
.. Set this token as the bearer token in your MCP client and make sure the authorization header is the configuration specifies `Bearer` before the token, for example, `Bearer <mcp_token>`.
13+
. Check the MCP endpoint configuration.
14+
.. Confirm that the MCP server URL properly resolves, particularly if you are using a desktop client.
15+
.. Use *legacy SSE endpoint* if your MCP client requires it instead of the Streamable endpoint. (For more details, see the *Configuration* topic).
16+
. Verify your {product-very-short} `{my-app-config-file}` file for duplicate backend entries and make sure that the indentation is accurate.
17+
.. Make sure that the configuration for the static token and MCP plugin sources go under an existing backend field, if one is present.
18+
.. If you are unsure, see {model-context-protocol-link}#proc-configuring-model-context-protocol[the sample app configuration provided in the reference procedure].

modules/model-context-protocol-tools/proc-resolving-common-problems-with-mcp-clients-and-tools.adoc

Lines changed: 0 additions & 46 deletions
This file was deleted.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="proc-resolving-the-model-does-not-support-tool-calling-error.adoc_{context}"]
4+
= Resolving the `Model does not support tool calling` error
5+
6+
This error indicates that the model configured in your MCP client lacks the required functionality to handle tool calls. The error message appears similar to: `Invalid request: model gemma3:27b does not support tool calls`.
7+
8+
.Procedure
9+
10+
. Consult your model documentation to confirm its support for tool calling.
11+
. If the current model does not support tool calling, change the model that your MCP client uses to a tool-calling compatible model.

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

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

66
.Procedure
77

8-
. Log in to the OCP cluster running RHDH and go to your {product-very-short} project using the following code:
8+
. Log in to the OCP cluster running {product-very-short} and go to your {product-very-short} project using the following code:
99
+
1010
[source,subs="+attributes]
1111
----

titles/model-context-protocol-tools/master.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ include::artifacts/attributes.adoc[]
22
:context: title-model-context-protocol-tools
33
:imagesdir: images
44
:title: Interacting with Model Context Protocol tools for {product}
5-
:subtitle: Leverage the Model Context Protocol (MCP) server to integrate {product} ({product-very-short}) with AI clients. This connection provides a standardized method for AI applications to access RHDH information and workflows through defined MCP tools.
6-
:abstract: Leverage the Model Context Protocol (MCP) server to integrate {product} ({product-very-short}) with AI clients. This connection provides a standardized method for AI applications to access RHDH information and workflows through defined MCP tools
5+
:subtitle: Leveraging the Model Context Protocol (MCP) server to integrate {product} ({product-very-short}) with AI clients
6+
:abstract: Leverage the Model Context Protocol (MCP) server to integrate {product} ({product-very-short}) with AI clients. This connection provides a standardized method for AI applications to access {product-very-short} information and workflows through defined MCP tools.
77
= {title}
88

99
include::assemblies/assembly-model-context-protocol-tools.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)