Skip to content

feat(mcp): capture resource discovery and reads - #928

Open
lucasheriques wants to merge 4 commits into
mainfrom
codex/mcp-resource-tracking
Open

feat(mcp): capture resource discovery and reads#928
lucasheriques wants to merge 4 commits into
mainfrom
codex/mcp-resource-tracking

Conversation

@lucasheriques

@lucasheriques lucasheriques commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

💡 Motivation and Context

MCP server authors cannot tell whether clients discover or read their resources.

This leaves resource-based integrations absent from MCP Analytics even when tool tracking works.

Resource bodies stay out of analytics because resources may contain private documents or credentials.

💚 How did you test it?

  • The MCP 1.x suite verifies resource discovery, reads, and preserved responses.
  • The MCP 2.x suite verifies the same behavior under the 2026-07-28 protocol.
  • The late-registration test verifies dynamically added resource handlers receive instrumentation.
  • Mypy passes against the repository baseline.

📝 Checklist

  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • I updated the docs if needed.
  • No breaking change or entry added to the changelog.

If releasing new changes

  • Ran sampo add to generate a changeset file

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Codex implemented this change with the debugging-mcp-analytics, writing-tests, and writing-pr-descriptions skills. The paired JavaScript implementation uses the same event contract to prevent SDK drift.

@lucasheriques
lucasheriques requested a review from a team as a code owner September 7, 2026 19:34
@lucasheriques lucasheriques self-assigned this Sep 7, 2026
@lucasheriques
lucasheriques requested a review from a team September 7, 2026 19:34
Comment thread posthog/mcp/_instrumentation.py Outdated
@veria-ai

veria-ai Bot commented Sep 7, 2026

Copy link
Copy Markdown

PR overview

This pull request adds capture of MCP resource discovery and resource read operations, including sanitization of resource URIs and related event data.

Two issues have already been addressed, with one denial-of-service concern remaining. An MCP client can submit a URI with an excessive number of query fields, causing synchronous parsing to consume disproportionate memory and block the server event loop; exploitation depends on the client being able to issue resource-read requests.

Open issues (1)

Fixed/addressed: 2 · PR risk: 4/10

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

posthog-python Compliance Report

Date: 2026-09-08 22:08:44 UTC
Duration: 256381ms

✅ All Tests Passed!

111/111 tests passed


Capture_V1 Tests

94/94 tests passed

View Details
Test Status Duration
Endpoint And Method.Targets V1 Endpoint 517ms
Endpoint And Method.Does Not Use Legacy Endpoints 510ms
Required Headers.Has Authorization Bearer Header 511ms
Required Headers.Has Content Type Json 510ms
Required Headers.Has Posthog Sdk Info Format 510ms
Required Headers.Has Posthog Attempt Header 510ms
Required Headers.Has Posthog Request Id 510ms
Required Headers.Has Posthog Request Timestamp 510ms
Required Headers.Has User Agent 510ms
Body Format.Body Has Created At And Batch 510ms
Body Format.No Api Key In Body 511ms
Body Format.No Sent At In Body 510ms
Event Format.Event Has Required Root Fields 509ms
Event Format.Event Uuid Is Valid 510ms
Event Format.Event Timestamp Is Rfc3339 510ms
Event Format.Distinct Id Is String 511ms
Event Format.Distinct Id At Root Not Properties 510ms
Event Format.Custom Properties Preserved 510ms
Event Format.Set Properties Preserved 510ms
Event Format.Set Once Properties Preserved 510ms
Event Format.Groups Properties Preserved 510ms
Event Format.Sdk Generates Uuid If Not Provided 509ms
Event Format.Event Has Required Root Fields Batch 514ms
Event Format.Event Uuid Is Valid Batch 513ms
Event Format.Event Timestamp Is Rfc3339 Batch 513ms
Event Format.Distinct Id Is String Batch 513ms
Event Format.Distinct Id At Root Not Properties Batch 513ms
Event Format.Custom Properties Preserved Batch 513ms
Event Format.Set Properties Preserved Batch 513ms
Event Format.Set Once Properties Preserved Batch 514ms
Event Format.Groups Properties Preserved Batch 513ms
Event Format.Sdk Generates Uuid If Not Provided Batch 513ms
Batch Behavior.Multiple Events In Single Batch 517ms
Batch Behavior.Batch Envelope Smoke 516ms
Batch Behavior.Flush With No Events Sends Nothing 506ms
Batch Behavior.Flush At Triggers Batch 1011ms
Batch Behavior.Created At Reflects Batch Creation Time 510ms
Deduplication.Generates Unique Uuids 518ms
Deduplication.Different Events Same Content Different Uuids 512ms
Deduplication.Preserves Uuid On Retry 6518ms
Deduplication.Preserves Timestamp On Retry 6518ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry 6523ms
Deduplication.No Duplicate Events In Batch 518ms
Header Behavior On Retry.Attempt Header Starts At One 509ms
Header Behavior On Retry.Attempt Header Increments On Retry 13527ms
Header Behavior On Retry.Request Id Preserved On Retry 6518ms
Header Behavior On Retry.Different Requests Have Different Request Ids 3020ms
Header Behavior On Retry.Request Timestamp Changes On Retry 6519ms
Response Format Validation.Success Response Has Uuid Keyed Results 511ms
Response Format Validation.Success Response Has Ok For Each Event 513ms
Response Format Validation.Success No Retry After When All Ok 512ms
Response Format Validation.Success Retry After Present When Retry Events 1515ms
Response Format Validation.Success No Retry After When Drop Only 513ms
Response Format Validation.Response Echoes Request Id 510ms
Retry Behavior.Retries On 408 6518ms
Retry Behavior.Retries On 500 6519ms
Retry Behavior.Retries On 503 8523ms
Retry Behavior.Retries On 504 6519ms
Retry Behavior.Retryable Errors Have Retry After 3516ms
Retry Behavior.Respects Retry After On Retryable Error 11520ms
Retry Behavior.Does Not Retry On 400 2513ms
Retry Behavior.Does Not Retry On 401 2512ms
Retry Behavior.Does Not Retry On 402 2512ms
Retry Behavior.Does Not Retry On 413 2513ms
Retry Behavior.Does Not Retry On 415 2512ms
Retry Behavior.Non Retryable Errors Have No Retry After 2514ms
Retry Behavior.Implements Backoff 22535ms
Retry Behavior.Max Retries Respected 22535ms
Partial Batch Handling.Handles 200 Full Success 2511ms
Partial Batch Handling.Handles 200 With All Ok 3517ms
Partial Batch Handling.Does Not Retry Dropped Events 3513ms
Partial Batch Handling.Does Not Retry Limited Events 3515ms
Partial Batch Handling.Prunes Ok Events On Partial Retry 6522ms
Partial Batch Handling.Prunes Dropped Events On Partial Retry 6521ms
Partial Batch Handling.Retries Only Retry Events From Partial 6523ms
Partial Batch Handling.Partial Retry Preserves Uuids 6521ms
Partial Batch Handling.Partial Retry Attempt Header Increments 6521ms
Partial Batch Handling.Partial Retry Request Id Preserved 6521ms
Partial Batch Handling.Respects Retry After On Partial 8519ms
Partial Batch Handling.Unknown Result Treated As Terminal 3514ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry 3516ms
Compression.Sends Gzip Content Encoding 511ms
Compression.No Content Encoding When Disabled 510ms
Compression.Compressed Body Is Decompressible 510ms
Error Handling.Does Not Retry On Unknown 4Xx 2512ms
Event Options.Cookieless Mode Override 511ms
Event Options.Disable Skew Correction Override 510ms
Event Options.Process Person Profile Override 511ms
Event Options.Product Tour Id Override 511ms
Event Options.Unset Options Omitted 510ms
Event Options.Options Override In Batch 513ms
Geoip And Historical Migration.Geoip Disable Injected Into Properties 510ms
Geoip And Historical Migration.Historical Migration Set In Body 510ms
Geoip And Historical Migration.Historical Migration Absent By Default 510ms

Feature_Flags Tests

17/17 tests passed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id 11ms
Request Payload.Flags Request Uses V2 Query Param 9ms
Request Payload.Flags Request Hits Flags Path Not Decide 9ms
Request Payload.Flags Request Omits Authorization Header 9ms
Request Payload.Token In Flags Body Matches Init 9ms
Request Payload.Groups Round Trip 9ms
Request Payload.Groups Default To Empty Object 9ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False 9ms
Request Payload.Disable Geoip Omitted Defaults To False 9ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key 9ms
Request Lifecycle.No Flags Request On Init Alone 4ms
Request Lifecycle.No Flags Request On Normal Capture 509ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests 14ms
Request Lifecycle.Mock Response Value Is Returned To Caller 9ms
Retry Behavior.Retries Flags On 502 313ms
Retry Behavior.Retries Flags On 504 313ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event 512ms

@greptile-apps

greptile-apps Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Security Review

Resource-read responses are exported to PostHog by default. Although recognized credentials and binary content are sanitized, arbitrary sensitive text can remain intact, so response-body capture needs an explicit privacy boundary.

Prompt To Fix All With AI
### Issue 1
posthog/mcp/_instrumentation.py:863
**Resource bodies leak sensitive data**

Resource reads now unconditionally include the full returned response in `$mcp_response`. Text resources can contain private documents, configuration, or credentials, but the sanitizer only masks sensitive dictionary keys and recognizable token patterns; ordinary sensitive text remains unchanged and is sent to PostHog. Capture only resource metadata by default, or require explicit opt-in before exporting resource bodies.

**How this was verified:** A successful `resources/read` result flows through `_wrap_response` into the PostHog capture pipeline, and the added tests confirm that its text content is emitted verbatim.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "feat(mcp): capture resource discovery an..." | Re-trigger Greptile

Comment thread posthog/mcp/_instrumentation.py Outdated
if event_type == MCPAnalyticsEventType.MCP_RESOURCES_READ
else None,
"parameters": build_captured_mcp_parameters(request),
"response": _wrap_response(response) if response is not None else None,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 security Resource bodies leak sensitive data

Resource reads now unconditionally include the full returned response in $mcp_response. Text resources can contain private documents, configuration, or credentials, but the sanitizer only masks sensitive dictionary keys and recognizable token patterns; ordinary sensitive text remains unchanged and is sent to PostHog. Capture only resource metadata by default, or require explicit opt-in before exporting resource bodies.

How this was verified: A successful resources/read result flows through _wrap_response into the PostHog capture pipeline, and the added tests confirm that its text content is emitted verbatim.

Knowledge Base Used: MCP event and session processing

Prompt To Fix With AI
This is a comment left during a code review.
Path: posthog/mcp/_instrumentation.py
Line: 863

Comment:
**Resource bodies leak sensitive data**

Resource reads now unconditionally include the full returned response in `$mcp_response`. Text resources can contain private documents, configuration, or credentials, but the sanitizer only masks sensitive dictionary keys and recognizable token patterns; ordinary sensitive text remains unchanged and is sent to PostHog. Capture only resource metadata by default, or require explicit opt-in before exporting resource bodies.

**How this was verified:** A successful `resources/read` result flows through `_wrap_response` into the PostHog capture pipeline, and the added tests confirm that its text content is emitted verbatim.

**Knowledge Base Used:** [MCP event and session processing](https://app.greptile.com/posthog-org-19734/-/custom-context/knowledge-base/posthog/posthog-python/-/docs/mcp-event-and-session-processing.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed in a341587: resource bodies are no longer included in analytics. We also fixed credential redaction for resource addresses in 62caaf1. Tests cover successful and failed reads and check that the token is absent from every captured event.

Apply existing credential redaction to resource-read names before the
primary event and exception sibling are built. Preserve the original
URI and resource result or exception received by the caller.

Extend the existing resource tests with successful and failing reads
containing an invented token; the two new cases fail before this fix
under each MCP major. Document the capture boundary and before_send.

Validation: MCP v1 245 passed; MCP v2 225 passed and 13 expected skips.
Ruff lint and formatting pass. Mypy baseline passes (227 source files).
Comment thread posthog/mcp/_sanitization.py
Parse captured URLs to remove userinfo and credential query values,
including common signed URL fields. Apply the same sanitization to URLs
inside exception messages without changing handler requests or responses.
Document the limits of key-based URL redaction.

Verification: reproduced the credential leak before the fix. MCP v1 suite:
260 passed; v2 suite: 240 passed, 13 skipped. Ruff check and format passed;
mypy baseline passed for 227 files. Regression coverage includes encoded
keys, duplicate query parameters, malformed URLs, and success/error events.
value = match.group(0)
try:
url = urlsplit(value)
query = parse_qsl(url.query, keep_blank_values=True)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Low: Unbounded URL query parsing

An MCP client can issue resources/read with a URI containing a very large number of &-separated query fields. parse_qsl materializes every field synchronously before the resource-name and event-size truncation runs, allowing repeated requests to consume disproportionate memory and block the server event loop. Bound the URL length before parsing and set a conservative max_num_fields, redacting the whole URL when either limit is exceeded.

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