Skip to content

FEAT: Add MCP-wrapped prompt chat target - #2585

Open
Java123456com wants to merge 1 commit into
microsoft:mainfrom
Java123456com:feat/mcp-wrapped-prompt-chat-target
Open

FEAT: Add MCP-wrapped prompt chat target#2585
Java123456com wants to merge 1 commit into
microsoft:mainfrom
Java123456com:feat/mcp-wrapped-prompt-chat-target

Conversation

@Java123456com

Copy link
Copy Markdown

Addresses #1273 (MCP integration), scoped along the refined direction from the issue discussion: composition/wrapping of a generic chat target, not OpenAIResponseTarget-specific. A design summary was posted on the issue before this PR; this PR is deliberately the phase-1 slice.

What this adds

MCPWrappedPromptChatTarget(inner_target, mcp_servers, ...) - a PromptTarget wrapper that composes MCP tool use into any inner target that supports system prompts and multi-turn conversation (LiteLLM, Azure ML, Hugging Face, ...). The wrapper:

  1. connects to the configured MCP servers (sessions established lazily, reused across sends, closed in cleanup_target_async);
  2. lists each server's tools and injects the catalog plus a strict TOOL_CALL: {json} protocol into the system context;
  3. drives a bounded agentic loop: model tool calls are executed through the MCP session, results are fed back as labeled TOOL_RESULT/TOOL_ERROR user turns, and the loop continues until the model answers without a tool call or max_tool_call_rounds (default 5) is exhausted;
  4. delegates every round through the inner target's _send_prompt_to_target_async extension point, so the inner target formats the full conversation each round (consistent with how chat targets consume normalized_conversation).

Intermediate agentic rounds stay inside the wrapper and are audit-logged (server, tool, arguments, result size); only the final response is returned to the caller, so memory and reports reflect conversation-level behavior.

MCPServerConfig / MCPTransport - stdio (subprocess) and streamable-http transports through the official mcp Python SDK, behind the new optional extra pyrit[mcp] (lazy import with an actionable install hint; no hard dependency). Transport connection parameters are validated at construction, and plain SSE is not carried forward (deprecated in favor of streamable-HTTP in the MCP spec).

Policy and audit - per-server allowed_tools plus a global allowlist, unknown-tool rejection without execution, per-call timeout, and a round cap with an explicit warning. Malformed TOOL_CALL payloads bounce back to the model as an error turn instead of being executed.

Design decisions (feedback welcome)

  • Text protocol vs native tool calls: for a generic PromptTarget wrapper there is no native tool-call channel; the protocol instructions are strict and parsing is defensive (last valid call wins, malformed calls are non-fatal). Wiring the existing MessagePieceType.MCP_CALL / MCP_LIST_TOOLS constants through OpenAIResponseTarget's native Responses-API MCP support is the natural phase 2 and is deliberately out of scope here.
  • Memory semantics: each round goes through the inner target's extension point; intermediate turns are not persisted to the wrapper's memory. If maintainers prefer full round-by-round persistence, that is a small change.
  • Example servers: only test fixtures ship in this PR (a tiny FastMCP server over stdio); curated example servers can live in docs/examples once the design is agreed.

Tests

tests/unit/mcp/ (20 tests):

  • test_mcp_client.py drives a real FastMCP server over stdio (subprocess) end-to-end: initialize handshake, list_tools catalog, call_tool round-trip, server-side tool errors surfacing as is_error, and unconnected-session errors.
  • test_mcp_wrapped_prompt_chat_target.py covers the loop protocol with stubbed sessions: catalog/system-context injection, tool-call round-trip, unknown-tool and allowlist denial (rejected without execution), round cap, malformed payload handling, capability validation of the inner target, and session cleanup.

All 20 pass, plus 1,274 passing tests across tests/unit/prompt_target and tests/unit/models; ruff check / ruff format clean; uv.lock regenerated for the new extra.

Adds native MCP (Model Context Protocol) tool use to PyRIT via composition,
per the implementation direction refined on microsoft#1273:

- MCPWrappedPromptChatTarget wraps any PromptTarget that supports system
  prompts and multi-turn conversations; it lists the tools of the configured
  MCP servers, injects the catalog plus a strict TOOL_CALL protocol into the
  system context, executes model-requested calls, and feeds results back as
  labeled turns inside a bounded agentic loop (max_tool_call_rounds).
- MCPServerConfig/MCPTransport support stdio and streamable-http transports
  through the official mcp Python SDK, behind the new optional extra
  pyrit[mcp] (lazy import with an actionable error).
- Policy and audit: per-server and global tool allowlists, unknown-tool
  rejection, per-call timeout, and audit logging of every tool invocation.

Intermediate rounds stay inside the wrapper; only the final response reaches
memory and scoring. Unit tests drive a real FastMCP server over stdio for the
client transport and cover the loop protocol (catalog injection, tool
execution round-trip, unknown/denied tool handling, round cap, cleanup).

Addresses microsoft#1273
@microsoft-github-policy-service

Copy link
Copy Markdown

Java123456com please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant