Skip to content

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

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

feat(mcp): capture resource discovery and reads#928
lucasheriques wants to merge 6 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

All previously flagged issues have been addressed. No open security concerns remain on this pull request.

Security review

No open security issues remain on this pull request.

Fixed/addressed: 3 · PR risk: 0/10

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

posthog-python Compliance Report

Date: 2026-09-09 18:11:35 UTC
Duration: 255878ms

✅ 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 512ms
Endpoint And Method.Does Not Use Legacy Endpoints 508ms
Required Headers.Has Authorization Bearer Header 508ms
Required Headers.Has Content Type Json 507ms
Required Headers.Has Posthog Sdk Info Format 508ms
Required Headers.Has Posthog Attempt Header 507ms
Required Headers.Has Posthog Request Id 508ms
Required Headers.Has Posthog Request Timestamp 507ms
Required Headers.Has User Agent 508ms
Body Format.Body Has Created At And Batch 507ms
Body Format.No Api Key In Body 509ms
Body Format.No Sent At In Body 507ms
Event Format.Event Has Required Root Fields 508ms
Event Format.Event Uuid Is Valid 507ms
Event Format.Event Timestamp Is Rfc3339 508ms
Event Format.Distinct Id Is String 507ms
Event Format.Distinct Id At Root Not Properties 508ms
Event Format.Custom Properties Preserved 507ms
Event Format.Set Properties Preserved 507ms
Event Format.Set Once Properties Preserved 508ms
Event Format.Groups Properties Preserved 507ms
Event Format.Sdk Generates Uuid If Not Provided 507ms
Event Format.Event Has Required Root Fields Batch 510ms
Event Format.Event Uuid Is Valid Batch 511ms
Event Format.Event Timestamp Is Rfc3339 Batch 526ms
Event Format.Distinct Id Is String Batch 509ms
Event Format.Distinct Id At Root Not Properties Batch 510ms
Event Format.Custom Properties Preserved Batch 510ms
Event Format.Set Properties Preserved Batch 510ms
Event Format.Set Once Properties Preserved Batch 510ms
Event Format.Groups Properties Preserved Batch 510ms
Event Format.Sdk Generates Uuid If Not Provided Batch 510ms
Batch Behavior.Multiple Events In Single Batch 512ms
Batch Behavior.Batch Envelope Smoke 511ms
Batch Behavior.Flush With No Events Sends Nothing 505ms
Batch Behavior.Flush At Triggers Batch 1009ms
Batch Behavior.Created At Reflects Batch Creation Time 508ms
Deduplication.Generates Unique Uuids 512ms
Deduplication.Different Events Same Content Different Uuids 509ms
Deduplication.Preserves Uuid On Retry 6516ms
Deduplication.Preserves Timestamp On Retry 6516ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry 6519ms
Deduplication.No Duplicate Events In Batch 512ms
Header Behavior On Retry.Attempt Header Starts At One 508ms
Header Behavior On Retry.Attempt Header Increments On Retry 13520ms
Header Behavior On Retry.Request Id Preserved On Retry 6516ms
Header Behavior On Retry.Different Requests Have Different Request Ids 3015ms
Header Behavior On Retry.Request Timestamp Changes On Retry 6516ms
Response Format Validation.Success Response Has Uuid Keyed Results 508ms
Response Format Validation.Success Response Has Ok For Each Event 510ms
Response Format Validation.Success No Retry After When All Ok 507ms
Response Format Validation.Success Retry After Present When Retry Events 1513ms
Response Format Validation.Success No Retry After When Drop Only 513ms
Response Format Validation.Response Echoes Request Id 507ms
Retry Behavior.Retries On 408 6516ms
Retry Behavior.Retries On 500 6513ms
Retry Behavior.Retries On 503 8518ms
Retry Behavior.Retries On 504 6515ms
Retry Behavior.Retryable Errors Have Retry After 3512ms
Retry Behavior.Respects Retry After On Retryable Error 11519ms
Retry Behavior.Does Not Retry On 400 2510ms
Retry Behavior.Does Not Retry On 401 2509ms
Retry Behavior.Does Not Retry On 402 2510ms
Retry Behavior.Does Not Retry On 413 2509ms
Retry Behavior.Does Not Retry On 415 2510ms
Retry Behavior.Non Retryable Errors Have No Retry After 2508ms
Retry Behavior.Implements Backoff 22529ms
Retry Behavior.Max Retries Respected 22532ms
Partial Batch Handling.Handles 200 Full Success 2510ms
Partial Batch Handling.Handles 200 With All Ok 3511ms
Partial Batch Handling.Does Not Retry Dropped Events 3513ms
Partial Batch Handling.Does Not Retry Limited Events 3513ms
Partial Batch Handling.Prunes Ok Events On Partial Retry 6518ms
Partial Batch Handling.Prunes Dropped Events On Partial Retry 6513ms
Partial Batch Handling.Retries Only Retry Events From Partial 6517ms
Partial Batch Handling.Partial Retry Preserves Uuids 6513ms
Partial Batch Handling.Partial Retry Attempt Header Increments 6517ms
Partial Batch Handling.Partial Retry Request Id Preserved 6513ms
Partial Batch Handling.Respects Retry After On Partial 8515ms
Partial Batch Handling.Unknown Result Treated As Terminal 3512ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry 3514ms
Compression.Sends Gzip Content Encoding 508ms
Compression.No Content Encoding When Disabled 506ms
Compression.Compressed Body Is Decompressible 506ms
Error Handling.Does Not Retry On Unknown 4Xx 2508ms
Event Options.Cookieless Mode Override 506ms
Event Options.Disable Skew Correction Override 506ms
Event Options.Process Person Profile Override 507ms
Event Options.Product Tour Id Override 506ms
Event Options.Unset Options Omitted 506ms
Event Options.Options Override In Batch 509ms
Geoip And Historical Migration.Geoip Disable Injected Into Properties 507ms
Geoip And Historical Migration.Historical Migration Set In Body 506ms
Geoip And Historical Migration.Historical Migration Absent By Default 506ms

Feature_Flags Tests

17/17 tests passed

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

@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.
Comment thread posthog/mcp/_sanitization.py Outdated
Combine resource URL credential redaction with main's intent PII and
model-metadata sanitization. Preserve the current MCP adapters and pipeline.

Validation: MCP v1 338 passed; MCP v2 312 passed, 17 expected skips.
Ruff lint/format and mypy baseline passed. CodeScene merge-wide findings
include upstream MCP complexity; unrelated refactors are deferred.
Reject captured URLs over 8,192 characters before copying or parsing them
and cap parse_qsl at 128 fields. Preserve caller requests and responses.
Document the limits and verify the boundary behavior in plain URLs and
exception messages.

Add real high-level resource-adapter coverage for early/late registration,
idempotency, success/failure events, duration, and response-body exclusion.
Validation: MCP v1 338 passed; MCP v2 312 passed, 17 expected skips. Ruff
lint/format and mypy baseline passed. The new adapter test scores 10.0
in CodeScene; broader existing sanitizer complexity is left unchanged.
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