Skip to content

Accept passthrough headers in agent execute #4364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Accept passthrough headers in agent execute #4364

wants to merge 2 commits into from

Conversation

@jiapingzeng
Copy link
Contributor

@jiapingzeng jiapingzeng commented Oct 29, 2025 •
edited
Loading

Description

Create MCP client on each execute request + forward headers to MCP connector

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Accepted headers:

x-amzn-fas-accesskey, x-amzn-fas-secretkey, x-amzn-fas-sessiontoken, x-amzn-datasources

Sample request:

POST {{endpoint}}/_plugins/_ml/agents/{{agent_id}}/_execute
--header 'x-amzn-fas-accesskey: example' \
--header 'x-amzn-fas-secretkey: example' \
--header 'x-amzn-fas-sessiontoken: example' \
--header 'x-amzn-datasources: https://example.aos.us-east-1.on.aws' \
--header 'Content-Type: application/json'
{
    "parameters": {
        "question": "list indices"
    },
    "verbose": "true"
}

Response:

{
    "inference_results": [
        {
            "output": [
                {
                    "name": "memory_id",
                    "result": "F7vALZoBCqjo4z06S5j0"
                },
                {
                    "name": "parent_interaction_id",
                    "result": "GbvALZoBCqjo4z06TZiW"
                },
                {
                    "name": "response",
                    "dataAsMap": {
                        "response": "Here are the indices in your OpenSearch cluster:\n\n## User Indices\n1. **tmdb** - 8,516 documents, green health\n...",
                        "additional_info": {}
                    }
                }
            ]
        }
    ]
}

Zhangxunmt
Zhangxunmt reviewed Oct 29, 2025
View reviewed changes
Copy link
Collaborator

@Zhangxunmt Zhangxunmt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spotless needs to apply

@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 29, 2025 19:48 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 29, 2025 19:48 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 29, 2025 19:48 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 29, 2025 19:48 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 30, 2025 01:54 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 30, 2025 01:54 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 30, 2025 01:54 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 30, 2025 01:54 — with GitHub Actions Waiting
@jiapingzeng
pass header to mcp connector
a00ed66 
Signed-off-by: Jiaping Zeng <[email protected]>
@jiapingzeng
fix tests
c14d0c5 
Signed-off-by: Jiaping Zeng <[email protected]>
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 30, 2025 02:15 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 30, 2025 02:15 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 30, 2025 02:15 — with GitHub Actions Waiting
@jiapingzeng jiapingzeng requested a deployment to ml-commons-cicd-env-require-approval October 30, 2025 02:15 — with GitHub Actions Waiting
arjunkumargiri
arjunkumargiri reviewed Nov 4, 2025
View reviewed changes
ml-algorithms/src/main/java/org/opensearch/ml/engine/algorithms/agent/AgentUtils.java
return Collections.emptyMap();
}

String headersJson = parameters.get(CommonValue.MCP_REQUEST_HEADERS);
Copy link
Contributor

@arjunkumargiri arjunkumargiri Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the expectation that header contains a json? this seems a anti pattern.

...lgorithms/src/main/java/org/opensearch/ml/engine/algorithms/remote/McpConnectorExecutor.java
Duration connectionTimeout = Duration.ofSeconds(super.getConnectorClientConfig().getConnectionTimeout());
Duration readTimeout = Duration.ofSeconds(super.getConnectorClientConfig().getReadTimeout());

Map<String, String> mergedHeaders = new HashMap<>();
Copy link
Contributor

@arjunkumargiri arjunkumargiri Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating a mergedHeaders might be unnecessary. Request header could be directly added to builder while creating headerConfig

...main/java/org/opensearch/ml/engine/algorithms/remote/McpStreamableHttpConnectorExecutor.java
Comment on lines +81 to +86
if (connector.getDecryptedHeaders() != null) {
mergedHeaders.putAll(connector.getDecryptedHeaders());
}
if (requestHeaders != null) {
mergedHeaders.putAll(requestHeaders);
}
Copy link
Contributor

@arjunkumargiri arjunkumargiri Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above.

plugin/src/main/java/org/opensearch/ml/utils/RestActionUtils.java
* @param request RestRequest containing the MCP headers
* @param agentInput AgentMLInput to add the headers to
*/
public static void addMcpRequestHeaders(RestRequest request, AgentMLInput agentInput) {
Copy link
Contributor

@arjunkumargiri arjunkumargiri Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add unit test.

plugin/src/main/java/org/opensearch/ml/utils/RestActionUtils.java
String headersJson = gson.toJson(headers);
RemoteInferenceInputDataSet inputDataSet = (RemoteInferenceInputDataSet) agentInput.getInputDataset();
if (inputDataSet != null && inputDataSet.getParameters() != null) {
inputDataSet.getParameters().put(CommonValue.MCP_REQUEST_HEADERS, headersJson);
Copy link
Contributor

@arjunkumargiri arjunkumargiri Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems we are overriding parameters to also include headers. Can we rather create a new header field to RemoteInferenceInputDataSet for headers?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Zhangxunmt Zhangxunmt Zhangxunmt left review comments

@b4sjoo b4sjoo Awaiting requested review from b4sjoo b4sjoo is a code owner

@dhrubo-os dhrubo-os Awaiting requested review from dhrubo-os dhrubo-os is a code owner

@mingshl mingshl Awaiting requested review from mingshl mingshl is a code owner

@jngz-es jngz-es Awaiting requested review from jngz-es jngz-es is a code owner

@model-collapse model-collapse Awaiting requested review from model-collapse model-collapse is a code owner

@rbhavna rbhavna Awaiting requested review from rbhavna rbhavna is a code owner

@ylwu-amzn ylwu-amzn Awaiting requested review from ylwu-amzn ylwu-amzn is a code owner

@zane-neo zane-neo Awaiting requested review from zane-neo zane-neo is a code owner

@austintlee austintlee Awaiting requested review from austintlee austintlee is a code owner

@HenryL27 HenryL27 Awaiting requested review from HenryL27 HenryL27 is a code owner

@sam-herman sam-herman Awaiting requested review from sam-herman sam-herman is a code owner

@xinyual xinyual Awaiting requested review from xinyual xinyual is a code owner

@pyek-bot pyek-bot Awaiting requested review from pyek-bot pyek-bot is a code owner

+1 more reviewer

@arjunkumargiri arjunkumargiri arjunkumargiri left review comments

Reviewers whose approvals may not affect merge requirements

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jiapingzeng @Zhangxunmt @arjunkumargiri