Skip to content

API Reference

The API reference is generated directly from the source code using mkdocstrings. Each section summarizes the public models, requests, and core services that you can import from mcp_pvp.

Core services

Vault

Main PVP Vault service.

Source code in src/mcp_pvp/vault.py
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
class Vault:
    """Main PVP Vault service."""

    def __init__(
        self,
        policy: Policy | None = None,
        detector: PIIDetector | str | None = None,
        secret_key: bytes | None = None,
        audit_logger: AuditLogger | None = None,
        executor: ToolExecutor | None = None,
    ):
        """
        Initialize Vault.

        Args:
            policy: Policy specification (default: deny all)
            detector: PII detector instance, or 'presidio' to use Presidio,
                     or None for RegexDetector (default)
            secret_key: Secret key for capabilities (default: generate random)
            audit_logger: Audit logger (default: in-memory)
            executor: ToolExecutor for deliver mode (default: None)
                     If None, deliver() will only prepare injected args without execution.
                     Provide your own executor to enable real tool execution in deliver().
        """
        self.policy = policy or Policy()
        self.policy_evaluator = PolicyEvaluator(self.policy)
        self.store = SessionStore()
        self.audit_logger = audit_logger or InMemoryAuditLogger()
        self.executor = executor

        # Initialize detector
        if isinstance(detector, PIIDetector):
            self.detector: PIIDetector = detector
        elif detector == "presidio":
            try:
                from mcp_pvp.detectors.presidio import PresidioDetector

                self.detector = PresidioDetector()
                logger.info("vault_initialized", detector="presidio")
            except Exception as e:
                logger.warning("presidio_unavailable", error=str(e), fallback="regex")
                self.detector = RegexDetector()
                logger.info("vault_initialized", detector="regex_fallback")
        else:
            self.detector = RegexDetector()
            logger.info("vault_initialized", detector="regex")

        # Initialize capability manager
        if secret_key is None:
            secret_key = secrets.token_bytes(32)
        self.cap_manager = CapabilityManager(secret_key)

    def issue_capability(
        self,
        vault_session: str,
        pii_ref: str,
        pii_type: PIIType,
        sink: Sink,
        run: RunContext | None = None,
        ttl_seconds: int = 300,
    ) -> str:
        """
        Issue a sink-specific capability after policy validation.

        SECURITY: This method should only be called AFTER policy.check_disclosure()
        succeeds. It creates a capability bound to the specific sink, tool name,
        and arg_path, preventing capability reuse attacks.

        Args:
            vault_session: Vault session ID
            pii_ref: PII token reference
            pii_type: PII type
            sink: Sink specification (kind, name, arg_path)
            run: Run context (optional)
            ttl_seconds: Capability TTL in seconds (default: 300 = 5 min)

        Returns:
            Capability string bound to the specific sink

        Example:
            >>> # After policy check passes:
            >>> cap = vault.issue_capability(
            ...     vault_session=\"vs_123\",
            ...     pii_ref=\"tkn_abc\",
            ...     pii_type=PIIType.EMAIL,
            ...     sink=Sink(kind=SinkKind.TOOL, name=\"send_email\", arg_path=\"to\"),
            ... )
        """
        return self.cap_manager.issue(
            vault_session=vault_session,
            pii_ref=pii_ref,
            pii_type=pii_type,
            sink=sink,
            run=run,
            ttl_seconds=ttl_seconds,
        )

    def tokenize(self, request: TokenizeRequest) -> TokenizeResponse:
        """
        Tokenize content containing PII.

        Args:
            request: TokenizeRequest

        Returns:
            TokenizeResponse with vault_session, redacted content, and tokens
        """
        logger.info(
            "vault_tokenize_start",
            content_length=len(request.content),
            token_format=request.token_format.value,
            workflow_run_id=request.run.workflow_run_id if request.run else None,
            step_id=request.run.step_id if request.run else None,
            vault_session=request.vault_session,
        )

        # Create or reuse vault session
        if request.vault_session:
            # Reuse existing session (e.g., for result tokenization)
            session = self.store.get_session(request.vault_session)
            logger.info(
                "vault_tokenize_reusing_session",
                vault_session=request.vault_session,
            )
        else:
            # Create new session
            session = self.store.create_session(ttl_seconds=request.session_ttl_seconds)

        # Detect PII
        detections = self.detector.detect(request.content, types=request.types)

        # Tokenize detections
        tokens: list[TextToken | JSONToken] = []
        token_replacements: list[tuple[int, int, str]] = []
        type_counts: dict[PIIType, int] = {}

        for detection in detections:
            # Store PII in vault
            stored = self.store.store_pii(
                session_id=session.session_id,
                pii_type=detection.pii_type.value,
                value=detection.text,
            )

            # Track type counts
            type_counts[detection.pii_type] = type_counts.get(detection.pii_type, 0) + 1

            # Create token
            token: TextToken | JSONToken
            if request.token_format == TokenFormat.TEXT:
                token = TextToken(ref=stored.ref, pii_type=detection.pii_type)
                token_str = token.to_text()
                tokens.append(token)
            else:  # JSON
                # SECURITY: Capabilities are NO LONGER issued during tokenization
                # They must be requested explicitly via vault.issue_capability()
                # after policy check in resolve/deliver operations.
                # This prevents capability reuse attacks.
                token = JSONToken(
                    pii_ref=stored.ref,
                    type=detection.pii_type,
                    cap=None,  # No capability at tokenization time
                )
                token_str = f"{{{token.model_dump_json()}}}"  # Simplified JSON representation
                tokens.append(token)

            # Record replacement
            token_replacements.append((detection.start, detection.end, token_str))

        # Redact content
        redacted = redact_content(request.content, token_replacements)

        # Create response
        stats = TokenStats(
            detections=len(detections),
            tokens_created=len(tokens),
            types=type_counts,
        )

        # Audit
        event = create_tokenize_event(
            vault_session=session.session_id,
            run=request.run,
            detections=stats.detections,
            tokens_created=stats.tokens_created,
            types=stats.types,
            parent_audit_id=request.parent_audit_id,
        )
        self.audit_logger.log_event(event)

        logger.info(
            "vault_tokenize_complete",
            vault_session=session.session_id,
            detections=stats.detections,
            tokens_created=stats.tokens_created,
        )

        return TokenizeResponse(
            vault_session=session.session_id,
            redacted=redacted,
            tokens=tokens,
            stats=stats,
            expires_at=session.expires_at,
        )

    def resolve(self, request: ResolveRequest) -> ResolveResponse:
        """
        Resolve tokens to raw values (with policy enforcement).

        Args:
            request: ResolveRequest

        Returns:
            ResolveResponse with raw values

        Raises:
            PolicyDeniedError: If policy denies disclosure
            CapabilityInvalidError: If capability is invalid
        """
        logger.info(
            "vault_resolve_start",
            vault_session=request.vault_session,
            sink_kind=request.sink.kind.value,
            sink_name=request.sink.name,
            token_count=len(request.tokens),
        )

        # Get session
        session = self.store.get_session(request.vault_session)

        values: dict[str, str] = {}
        disclosed_types: dict[PIIType, int] = {}

        for token_req in request.tokens:
            # Get stored PII
            stored = self.store.get_pii(request.vault_session, token_req.ref)

            # Check policy FIRST (before issuing capability)
            try:
                self.policy_evaluator.check_disclosure(
                    session=session,
                    pii_type=stored.pii_type,
                    sink=request.sink,
                    run=request.run,
                    value_size=len(stored.value),
                )
            except PolicyDeniedError as e:
                # Log policy denial
                self.audit_logger.log_event(
                    create_policy_denied_event(
                        vault_session=request.vault_session,
                        pii_type=stored.pii_type,
                        sink_kind=request.sink.kind.value,
                        sink_name=request.sink.name,
                        run=request.run,
                        reason=str(e),
                    )
                )
                raise

            # Issue capability if not provided (security: on-demand issuance)
            cap_string = token_req.cap
            if cap_string is None:
                cap_string = self.issue_capability(
                    vault_session=request.vault_session,
                    pii_ref=token_req.ref,
                    pii_type=stored.pii_type,
                    sink=request.sink,
                    run=request.run,
                    ttl_seconds=300,  # 5 minutes
                )

            # Verify capability (even if we just issued it - validates structure)
            self.cap_manager.verify(
                cap_string=cap_string,
                vault_session=request.vault_session,
                pii_ref=token_req.ref,
                sink=request.sink,
                run=request.run,
            )

            # Record disclosure
            self.policy_evaluator.record_disclosure(session, len(stored.value))

            # Add to result
            values[token_req.ref] = stored.value
            disclosed_types[stored.pii_type] = disclosed_types.get(stored.pii_type, 0) + 1

        # Audit
        event = create_resolve_event(
            vault_session=request.vault_session,
            run=request.run,
            sink_kind=request.sink.kind.value,
            sink_name=request.sink.name,
            disclosed=disclosed_types,
        )
        self.audit_logger.log_event(event)

        logger.info(
            "vault_resolve_complete",
            vault_session=request.vault_session,
            disclosed_count=len(values),
        )

        return ResolveResponse(
            values=values,
            audit_id=event.audit_id,
            disclosed=disclosed_types,
        )

    def tokenize_tool_result(
        self,
        tool_result: Any,
        vault_session: str,
        run: RunContext | None = None,
        parent_audit_id: str | None = None,
    ) -> tuple[Any, list[JSONToken | TextToken]]:
        """
        Tokenize tool result to prevent PII leakage while preserving structure.

        This method detects PII in tool results and replaces it with tokens,
        preventing sensitive data from leaking back to the caller. It recursively
        traverses the result structure and replaces PII in string values while
        maintaining the original data types and structure.

        Args:
            tool_result: The result from tool execution (any type)
            vault_session: Vault session ID for token storage
            run: Run context (optional)
            parent_audit_id: Parent audit ID to link tokenization (optional)

        Returns:
            Tuple of (tokenized_result, result_tokens):
            - tokenized_result: Result with PII replaced by TEXT format tokens (same structure)
            - result_tokens: List of tokens found in the result

        Example:
            >>> result = {"email": "user@example.com", "status": "sent"}
            >>> tokenized, tokens = vault.tokenize_tool_result(
            ...     tool_result=result,
            ...     vault_session="vs_123",
            ... )
            >>> # tokenized contains: {"email": "[[PII:EMAIL:tkn_abc]]", "status": "sent"}
            >>> # tokens contains: [TextToken(ref="tkn_abc", type=PIIType.EMAIL)]
        """
        if tool_result is None:
            return tool_result, []

        # Collect all tokens created during traversal
        all_tokens: list[JSONToken | TextToken] = []

        def tokenize_value_recursive(value: Any) -> Any:
            """Recursively tokenize PII in values while preserving structure."""
            # Handle None
            if value is None:
                return None

            # Handle strings - detect and replace PII
            if isinstance(value, str):
                # Tokenize the string content
                tokenization = self.tokenize(
                    TokenizeRequest(
                        content=value,
                        vault_session=vault_session,
                        token_format=TokenFormat.TEXT,
                        run=run,
                        parent_audit_id=parent_audit_id,
                    )
                )
                # Collect tokens
                all_tokens.extend(tokenization.tokens)
                # Return redacted string
                return tokenization.redacted

            # Handle dicts - recursively process values
            elif isinstance(value, dict):
                return {k: tokenize_value_recursive(v) for k, v in value.items()}

            # Handle lists - recursively process items
            elif isinstance(value, list):
                return [tokenize_value_recursive(item) for item in value]

            # Handle tuples - recursively process items, return as tuple
            elif isinstance(value, tuple):
                return tuple(tokenize_value_recursive(item) for item in value)

            # Handle sets - recursively process items, return as set
            elif isinstance(value, set):
                return {tokenize_value_recursive(item) for item in value}

            # Handle objects with __dict__ (like Pydantic models, custom classes)
            # This includes MCP's ContentBlock types
            elif hasattr(value, "__dict__") and hasattr(value, "__class__"):
                # For objects with attributes, we need to rebuild them
                # Get the object's dict representation
                obj_dict = {}
                for attr_name in dir(value):
                    if not attr_name.startswith("_"):
                        try:
                            attr_value = getattr(value, attr_name)
                            # Skip methods
                            if not callable(attr_value):
                                obj_dict[attr_name] = attr_value
                        except Exception:
                            logger.exception(
                                "vault_tokenize_tool_result_attr_error",
                                attr_name=attr_name,
                                error=traceback.format_exc(),
                            )
                            continue

                # Tokenize the dict representation
                tokenized_dict = tokenize_value_recursive(obj_dict)

                # Try to reconstruct the object with tokenized values
                try:
                    # For Pydantic models and similar, try to create new instance
                    if hasattr(value.__class__, "model_validate"):
                        # Pydantic v2
                        return value.__class__.model_validate(tokenized_dict)
                    elif hasattr(value.__class__, "parse_obj"):
                        # Pydantic v1
                        return value.__class__.parse_obj(tokenized_dict)
                    else:
                        # For other types, try to use constructor
                        return value.__class__(**tokenized_dict)
                except Exception:
                    # If reconstruction fails, return the tokenized dict
                    return tokenized_dict

            # For other types (int, float, bool, etc.), return as-is
            # This includes numbers, booleans, dates, etc.
            else:
                return value

        # Tokenize the result recursively
        tokenized_result = tokenize_value_recursive(tool_result)

        return tokenized_result, all_tokens

    def resolve_tokens_in_args(
        self,
        args: dict[str, Any],
        vault_session: str,
        tool_name: str,
        run: RunContext | None = None,
    ) -> tuple[dict[str, str], dict[PIIType, int]]:
        """
        Extract tokens from arguments, validate policy, and return replacements.

        This helper method handles both JSON and TEXT format tokens embedded in
        arguments, validates policy for each token, and returns the PII replacements
        that should be injected.

        Args:
            args: Tool arguments that may contain tokens
            vault_session: Vault session ID
            tool_name: Name of the tool (for sink specification)
            run: Run context (optional)

        Returns:
            Tuple of (replacements, disclosed_types):
            - replacements: Dict mapping token refs to actual PII values
            - disclosed_types: Dict counting disclosures by PII type

        Raises:
            PolicyDeniedError: If policy denies disclosure for any token
            CapabilityInvalidError: If capability verification fails

        Example:
            >>> replacements, disclosed = vault.resolve_tokens_in_args(
            ...     args={"to": {"$pii_ref": "tkn_abc", "type": "EMAIL"}},
            ...     vault_session="vs_123",
            ...     tool_name="send_email",
            ... )
        """
        # Get session
        session = self.store.get_session(vault_session)

        # Extract JSON tokens from args with their paths
        json_token_paths = extract_json_tokens(args)

        # Build replacements and verify
        replacements: dict[str, str] = {}
        disclosed_types: dict[PIIType, int] = {}

        # Process JSON format tokens
        for token, path in json_token_paths:
            # Extract just the top-level key from path (e.g., "to" from "to.nested")
            arg_path = path.split(".")[0] if path else None

            sink = Sink(
                kind=SinkKind.TOOL,
                name=tool_name,
                arg_path=arg_path,
            )

            # Get stored PII
            stored = self.store.get_pii(vault_session, token.pii_ref)

            # Verify capability if provided
            if token.cap:
                self.cap_manager.verify(
                    cap_string=token.cap,
                    vault_session=vault_session,
                    pii_ref=token.pii_ref,
                    sink=sink,
                    run=run,
                )

            # Check policy
            try:
                self.policy_evaluator.check_disclosure(
                    session=session,
                    pii_type=stored.pii_type,
                    sink=sink,
                    run=run,
                    value_size=len(stored.value),
                )
            except PolicyDeniedError as e:
                # Audit denial
                event = create_policy_denied_event(
                    vault_session=vault_session,
                    run=run,
                    pii_type=stored.pii_type,
                    sink_kind=sink.kind.value,
                    sink_name=sink.name,
                    reason=e.message,
                )
                self.audit_logger.log_event(event)
                raise

            # Record disclosure
            self.policy_evaluator.record_disclosure(session, len(stored.value))

            # Add to replacements
            replacements[token.pii_ref] = stored.value
            disclosed_types[stored.pii_type] = disclosed_types.get(stored.pii_type, 0) + 1

        # Process TEXT format tokens embedded in string arguments
        def extract_text_tokens_recursive(
            obj: Any, current_path: str = ""
        ) -> list[tuple[TextToken, str]]:
            """Recursively extract TEXT tokens from strings in data structure."""
            tokens_with_paths: list[tuple[TextToken, str]] = []

            if isinstance(obj, str):
                text_tokens = extract_text_tokens(obj)
                for text_token in text_tokens:
                    tokens_with_paths.append((text_token, current_path))
            elif isinstance(obj, dict):
                for key, value in obj.items():
                    new_path = f"{current_path}.{key}" if current_path else key
                    tokens_with_paths.extend(extract_text_tokens_recursive(value, new_path))
            elif isinstance(obj, list):
                for idx, item in enumerate(obj):
                    new_path = f"{current_path}[{idx}]"
                    tokens_with_paths.extend(extract_text_tokens_recursive(item, new_path))

            return tokens_with_paths

        text_token_paths = extract_text_tokens_recursive(args)

        for text_token, path in text_token_paths:
            # Extract just the top-level key from path (strip array indices and nested paths)
            # e.g., "messages[0]" -> "messages", "config.nested.deep" -> "config"
            arg_path = path.split(".")[0].split("[")[0] if path else None

            sink = Sink(
                kind=SinkKind.TOOL,
                name=tool_name,
                arg_path=arg_path,
            )

            # Get stored PII
            stored = self.store.get_pii(vault_session, text_token.ref)

            # Check policy
            try:
                self.policy_evaluator.check_disclosure(
                    session=session,
                    pii_type=stored.pii_type,
                    sink=sink,
                    run=run,
                    value_size=len(stored.value),
                )
            except PolicyDeniedError as e:
                # Audit denial
                event = create_policy_denied_event(
                    vault_session=vault_session,
                    run=run,
                    pii_type=stored.pii_type,
                    sink_kind=sink.kind.value,
                    sink_name=sink.name,
                    reason=e.message,
                )
                self.audit_logger.log_event(event)
                raise

            # Add to replacements and record disclosure (only for unique refs)
            if text_token.ref not in replacements:
                replacements[text_token.ref] = stored.value
                disclosed_types[stored.pii_type] = disclosed_types.get(stored.pii_type, 0) + 1
                # Record disclosure only once per unique token reference
                self.policy_evaluator.record_disclosure(session, len(stored.value))

        return replacements, disclosed_types

    def inject_pii_into_args(
        self, args: dict[str, Any], replacements: dict[str, str]
    ) -> dict[str, Any] | list[Any] | str | Any:
        """
        Replace tokens in arguments with actual PII values.

        Handles both JSON and TEXT format tokens, recursively traversing
        the argument structure.

        Args:
            args: Tool arguments containing tokens
            replacements: Dict mapping token refs to PII values

        Returns:
            New arguments dict with tokens replaced by actual values

        Example:
            >>> replacements = {"tkn_abc": "user@example.com"}
            >>> injected = vault.inject_pii_into_args(
            ...     args={"to": "[[PII:EMAIL:tkn_abc]]"},
            ...     replacements=replacements,
            ... )
            >>> # injected = {"to": "user@example.com"}
        """
        # Replace JSON tokens
        injected_args = replace_json_tokens(args, replacements)

        # Also replace TEXT format tokens in strings recursively
        def replace_text_tokens_recursive(
            obj: dict[str, Any] | list[Any] | str | Any,
        ) -> dict[str, Any] | list[Any] | str | Any:
            """Recursively replace TEXT tokens in strings."""
            if isinstance(obj, str):
                return replace_text_tokens(obj, replacements)
            elif isinstance(obj, dict):
                return {k: replace_text_tokens_recursive(v) for k, v in obj.items()}
            elif isinstance(obj, list):
                return [replace_text_tokens_recursive(item) for item in obj]
            return obj

        injected_args = replace_text_tokens_recursive(injected_args)
        return injected_args

    async def deliver(self, request: DeliverRequest) -> DeliverResponse:
        """
        Deliver: inject PII into tool call arguments and optionally execute.

        This method performs policy validation, token resolution, and PII injection
        into tool call arguments. If an executor is configured, it will also execute
        the tool call and tokenize results. Otherwise, it only prepares the injected
        arguments for external execution (useful for MCP server integration).

        Args:
            request: DeliverRequest containing tool call and tokens

        Returns:
            DeliverResponse with execution results and audit trail

        Raises:
            PolicyDeniedError: If policy denies disclosure
            CapabilityInvalidError: If capability is invalid

        Note:
            If no executor is configured (executor=None), this method will prepare
            injected arguments but will NOT execute the tool. The tool_result will
            be None in this case.
        """
        logger.info(
            "vault_deliver_start",
            vault_session=request.vault_session,
            tool_name=request.tool_call.name,
        )

        # Resolve tokens and get replacements (with policy enforcement)
        replacements, disclosed_types = self.resolve_tokens_in_args(
            args=request.tool_call.args,
            vault_session=request.vault_session,
            tool_name=request.tool_call.name,
            run=request.run,
        )

        # Inject PII values into arguments
        injected_args = self.inject_pii_into_args(request.tool_call.args, replacements)

        # SECURITY: Raw PII exists in injected_args - handle with care
        # Execute tool call via executor (if provided)
        tool_result: Any = None
        if self.executor is not None:
            try:
                tool_result = await self.executor.execute(
                    tool_name=request.tool_call.name,
                    injected_args=cast("dict[str, Any]", injected_args),
                )
            except Exception as e:
                # SECURITY: Scrub PII from exception message before logging
                error_msg = str(e)

                # Tokenize the error message to remove PII
                tokenize_resp = self.tokenize(
                    TokenizeRequest(
                        content=error_msg,
                        vault_session=request.vault_session,
                        run=request.run,
                        token_format=TokenFormat.TEXT,
                    )
                )
                scrubbed_error = tokenize_resp.redacted

                # Audit the failed deliver attempt for complete audit trail
                deliver_event = create_deliver_event(
                    vault_session=request.vault_session,
                    run=request.run,
                    tool_name=request.tool_call.name,
                    disclosed=disclosed_types,
                )
                self.audit_logger.log_event(deliver_event)

                # Log execution failure with scrubbed error message
                logger.error(
                    "tool_execution_failed",
                    tool_name=request.tool_call.name,
                    error=scrubbed_error,
                    audit_id=deliver_event.audit_id,
                )

                # SECURITY: Return scrubbed error instead of raising
                # This prevents raw PII from appearing in stack traces
                return DeliverResponse(
                    delivered=False,
                    tool_result=None,
                    result_tokens=[],
                    audit_id=deliver_event.audit_id,
                    error=scrubbed_error,
                )

        # Audit the deliver event BEFORE result tokenization so we can link them
        deliver_event = create_deliver_event(
            vault_session=request.vault_session,
            run=request.run,
            tool_name=request.tool_call.name,
            disclosed=disclosed_types,
        )
        self.audit_logger.log_event(deliver_event)

        # SECURITY: Tokenize tool result to prevent PII leakage
        tokenized_result, result_tokens = self.tokenize_tool_result(
            tool_result=tool_result,
            vault_session=request.vault_session,
            run=request.run,
            parent_audit_id=deliver_event.audit_id,
        )

        logger.info(
            "vault_deliver_complete",
            vault_session=request.vault_session,
            tool_name=request.tool_call.name,
            disclosed_count=len(replacements),
            result_tokens_found=len(result_tokens),
        )

        return DeliverResponse(
            delivered=True,
            tool_result=tokenized_result,
            result_tokens=result_tokens,
            audit_id=deliver_event.audit_id,
        )

__init__(policy=None, detector=None, secret_key=None, audit_logger=None, executor=None)

Initialize Vault.

Parameters:

Name Type Description Default
policy Policy | None

Policy specification (default: deny all)

None
detector PIIDetector | str | None

PII detector instance, or 'presidio' to use Presidio, or None for RegexDetector (default)

None
secret_key bytes | None

Secret key for capabilities (default: generate random)

None
audit_logger AuditLogger | None

Audit logger (default: in-memory)

None
executor ToolExecutor | None

ToolExecutor for deliver mode (default: None) If None, deliver() will only prepare injected args without execution. Provide your own executor to enable real tool execution in deliver().

None
Source code in src/mcp_pvp/vault.py
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def __init__(
    self,
    policy: Policy | None = None,
    detector: PIIDetector | str | None = None,
    secret_key: bytes | None = None,
    audit_logger: AuditLogger | None = None,
    executor: ToolExecutor | None = None,
):
    """
    Initialize Vault.

    Args:
        policy: Policy specification (default: deny all)
        detector: PII detector instance, or 'presidio' to use Presidio,
                 or None for RegexDetector (default)
        secret_key: Secret key for capabilities (default: generate random)
        audit_logger: Audit logger (default: in-memory)
        executor: ToolExecutor for deliver mode (default: None)
                 If None, deliver() will only prepare injected args without execution.
                 Provide your own executor to enable real tool execution in deliver().
    """
    self.policy = policy or Policy()
    self.policy_evaluator = PolicyEvaluator(self.policy)
    self.store = SessionStore()
    self.audit_logger = audit_logger or InMemoryAuditLogger()
    self.executor = executor

    # Initialize detector
    if isinstance(detector, PIIDetector):
        self.detector: PIIDetector = detector
    elif detector == "presidio":
        try:
            from mcp_pvp.detectors.presidio import PresidioDetector

            self.detector = PresidioDetector()
            logger.info("vault_initialized", detector="presidio")
        except Exception as e:
            logger.warning("presidio_unavailable", error=str(e), fallback="regex")
            self.detector = RegexDetector()
            logger.info("vault_initialized", detector="regex_fallback")
    else:
        self.detector = RegexDetector()
        logger.info("vault_initialized", detector="regex")

    # Initialize capability manager
    if secret_key is None:
        secret_key = secrets.token_bytes(32)
    self.cap_manager = CapabilityManager(secret_key)

deliver(request) async

Deliver: inject PII into tool call arguments and optionally execute.

This method performs policy validation, token resolution, and PII injection into tool call arguments. If an executor is configured, it will also execute the tool call and tokenize results. Otherwise, it only prepares the injected arguments for external execution (useful for MCP server integration).

Parameters:

Name Type Description Default
request DeliverRequest

DeliverRequest containing tool call and tokens

required

Returns:

Type Description
DeliverResponse

DeliverResponse with execution results and audit trail

Raises:

Type Description
PolicyDeniedError

If policy denies disclosure

CapabilityInvalidError

If capability is invalid

Note

If no executor is configured (executor=None), this method will prepare injected arguments but will NOT execute the tool. The tool_result will be None in this case.

Source code in src/mcp_pvp/vault.py
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
async def deliver(self, request: DeliverRequest) -> DeliverResponse:
    """
    Deliver: inject PII into tool call arguments and optionally execute.

    This method performs policy validation, token resolution, and PII injection
    into tool call arguments. If an executor is configured, it will also execute
    the tool call and tokenize results. Otherwise, it only prepares the injected
    arguments for external execution (useful for MCP server integration).

    Args:
        request: DeliverRequest containing tool call and tokens

    Returns:
        DeliverResponse with execution results and audit trail

    Raises:
        PolicyDeniedError: If policy denies disclosure
        CapabilityInvalidError: If capability is invalid

    Note:
        If no executor is configured (executor=None), this method will prepare
        injected arguments but will NOT execute the tool. The tool_result will
        be None in this case.
    """
    logger.info(
        "vault_deliver_start",
        vault_session=request.vault_session,
        tool_name=request.tool_call.name,
    )

    # Resolve tokens and get replacements (with policy enforcement)
    replacements, disclosed_types = self.resolve_tokens_in_args(
        args=request.tool_call.args,
        vault_session=request.vault_session,
        tool_name=request.tool_call.name,
        run=request.run,
    )

    # Inject PII values into arguments
    injected_args = self.inject_pii_into_args(request.tool_call.args, replacements)

    # SECURITY: Raw PII exists in injected_args - handle with care
    # Execute tool call via executor (if provided)
    tool_result: Any = None
    if self.executor is not None:
        try:
            tool_result = await self.executor.execute(
                tool_name=request.tool_call.name,
                injected_args=cast("dict[str, Any]", injected_args),
            )
        except Exception as e:
            # SECURITY: Scrub PII from exception message before logging
            error_msg = str(e)

            # Tokenize the error message to remove PII
            tokenize_resp = self.tokenize(
                TokenizeRequest(
                    content=error_msg,
                    vault_session=request.vault_session,
                    run=request.run,
                    token_format=TokenFormat.TEXT,
                )
            )
            scrubbed_error = tokenize_resp.redacted

            # Audit the failed deliver attempt for complete audit trail
            deliver_event = create_deliver_event(
                vault_session=request.vault_session,
                run=request.run,
                tool_name=request.tool_call.name,
                disclosed=disclosed_types,
            )
            self.audit_logger.log_event(deliver_event)

            # Log execution failure with scrubbed error message
            logger.error(
                "tool_execution_failed",
                tool_name=request.tool_call.name,
                error=scrubbed_error,
                audit_id=deliver_event.audit_id,
            )

            # SECURITY: Return scrubbed error instead of raising
            # This prevents raw PII from appearing in stack traces
            return DeliverResponse(
                delivered=False,
                tool_result=None,
                result_tokens=[],
                audit_id=deliver_event.audit_id,
                error=scrubbed_error,
            )

    # Audit the deliver event BEFORE result tokenization so we can link them
    deliver_event = create_deliver_event(
        vault_session=request.vault_session,
        run=request.run,
        tool_name=request.tool_call.name,
        disclosed=disclosed_types,
    )
    self.audit_logger.log_event(deliver_event)

    # SECURITY: Tokenize tool result to prevent PII leakage
    tokenized_result, result_tokens = self.tokenize_tool_result(
        tool_result=tool_result,
        vault_session=request.vault_session,
        run=request.run,
        parent_audit_id=deliver_event.audit_id,
    )

    logger.info(
        "vault_deliver_complete",
        vault_session=request.vault_session,
        tool_name=request.tool_call.name,
        disclosed_count=len(replacements),
        result_tokens_found=len(result_tokens),
    )

    return DeliverResponse(
        delivered=True,
        tool_result=tokenized_result,
        result_tokens=result_tokens,
        audit_id=deliver_event.audit_id,
    )

inject_pii_into_args(args, replacements)

Replace tokens in arguments with actual PII values.

Handles both JSON and TEXT format tokens, recursively traversing the argument structure.

Parameters:

Name Type Description Default
args dict[str, Any]

Tool arguments containing tokens

required
replacements dict[str, str]

Dict mapping token refs to PII values

required

Returns:

Type Description
dict[str, Any] | list[Any] | str | Any

New arguments dict with tokens replaced by actual values

Example

replacements = {"tkn_abc": "user@example.com"} injected = vault.inject_pii_into_args( ... args={"to": "[[PII:EMAIL:tkn_abc]]"}, ... replacements=replacements, ... )

injected = {"to": "user@example.com"}

Source code in src/mcp_pvp/vault.py
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
def inject_pii_into_args(
    self, args: dict[str, Any], replacements: dict[str, str]
) -> dict[str, Any] | list[Any] | str | Any:
    """
    Replace tokens in arguments with actual PII values.

    Handles both JSON and TEXT format tokens, recursively traversing
    the argument structure.

    Args:
        args: Tool arguments containing tokens
        replacements: Dict mapping token refs to PII values

    Returns:
        New arguments dict with tokens replaced by actual values

    Example:
        >>> replacements = {"tkn_abc": "user@example.com"}
        >>> injected = vault.inject_pii_into_args(
        ...     args={"to": "[[PII:EMAIL:tkn_abc]]"},
        ...     replacements=replacements,
        ... )
        >>> # injected = {"to": "user@example.com"}
    """
    # Replace JSON tokens
    injected_args = replace_json_tokens(args, replacements)

    # Also replace TEXT format tokens in strings recursively
    def replace_text_tokens_recursive(
        obj: dict[str, Any] | list[Any] | str | Any,
    ) -> dict[str, Any] | list[Any] | str | Any:
        """Recursively replace TEXT tokens in strings."""
        if isinstance(obj, str):
            return replace_text_tokens(obj, replacements)
        elif isinstance(obj, dict):
            return {k: replace_text_tokens_recursive(v) for k, v in obj.items()}
        elif isinstance(obj, list):
            return [replace_text_tokens_recursive(item) for item in obj]
        return obj

    injected_args = replace_text_tokens_recursive(injected_args)
    return injected_args

issue_capability(vault_session, pii_ref, pii_type, sink, run=None, ttl_seconds=300)

Issue a sink-specific capability after policy validation.

SECURITY: This method should only be called AFTER policy.check_disclosure() succeeds. It creates a capability bound to the specific sink, tool name, and arg_path, preventing capability reuse attacks.

Parameters:

Name Type Description Default
vault_session str

Vault session ID

required
pii_ref str

PII token reference

required
pii_type PIIType

PII type

required
sink Sink

Sink specification (kind, name, arg_path)

required
run RunContext | None

Run context (optional)

None
ttl_seconds int

Capability TTL in seconds (default: 300 = 5 min)

300

Returns:

Type Description
str

Capability string bound to the specific sink

Example

After policy check passes:

cap = vault.issue_capability( ... vault_session="vs_123", ... pii_ref="tkn_abc", ... pii_type=PIIType.EMAIL, ... sink=Sink(kind=SinkKind.TOOL, name="send_email", arg_path="to"), ... )

Source code in src/mcp_pvp/vault.py
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
def issue_capability(
    self,
    vault_session: str,
    pii_ref: str,
    pii_type: PIIType,
    sink: Sink,
    run: RunContext | None = None,
    ttl_seconds: int = 300,
) -> str:
    """
    Issue a sink-specific capability after policy validation.

    SECURITY: This method should only be called AFTER policy.check_disclosure()
    succeeds. It creates a capability bound to the specific sink, tool name,
    and arg_path, preventing capability reuse attacks.

    Args:
        vault_session: Vault session ID
        pii_ref: PII token reference
        pii_type: PII type
        sink: Sink specification (kind, name, arg_path)
        run: Run context (optional)
        ttl_seconds: Capability TTL in seconds (default: 300 = 5 min)

    Returns:
        Capability string bound to the specific sink

    Example:
        >>> # After policy check passes:
        >>> cap = vault.issue_capability(
        ...     vault_session=\"vs_123\",
        ...     pii_ref=\"tkn_abc\",
        ...     pii_type=PIIType.EMAIL,
        ...     sink=Sink(kind=SinkKind.TOOL, name=\"send_email\", arg_path=\"to\"),
        ... )
    """
    return self.cap_manager.issue(
        vault_session=vault_session,
        pii_ref=pii_ref,
        pii_type=pii_type,
        sink=sink,
        run=run,
        ttl_seconds=ttl_seconds,
    )

resolve(request)

Resolve tokens to raw values (with policy enforcement).

Parameters:

Name Type Description Default
request ResolveRequest

ResolveRequest

required

Returns:

Type Description
ResolveResponse

ResolveResponse with raw values

Raises:

Type Description
PolicyDeniedError

If policy denies disclosure

CapabilityInvalidError

If capability is invalid

Source code in src/mcp_pvp/vault.py
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
def resolve(self, request: ResolveRequest) -> ResolveResponse:
    """
    Resolve tokens to raw values (with policy enforcement).

    Args:
        request: ResolveRequest

    Returns:
        ResolveResponse with raw values

    Raises:
        PolicyDeniedError: If policy denies disclosure
        CapabilityInvalidError: If capability is invalid
    """
    logger.info(
        "vault_resolve_start",
        vault_session=request.vault_session,
        sink_kind=request.sink.kind.value,
        sink_name=request.sink.name,
        token_count=len(request.tokens),
    )

    # Get session
    session = self.store.get_session(request.vault_session)

    values: dict[str, str] = {}
    disclosed_types: dict[PIIType, int] = {}

    for token_req in request.tokens:
        # Get stored PII
        stored = self.store.get_pii(request.vault_session, token_req.ref)

        # Check policy FIRST (before issuing capability)
        try:
            self.policy_evaluator.check_disclosure(
                session=session,
                pii_type=stored.pii_type,
                sink=request.sink,
                run=request.run,
                value_size=len(stored.value),
            )
        except PolicyDeniedError as e:
            # Log policy denial
            self.audit_logger.log_event(
                create_policy_denied_event(
                    vault_session=request.vault_session,
                    pii_type=stored.pii_type,
                    sink_kind=request.sink.kind.value,
                    sink_name=request.sink.name,
                    run=request.run,
                    reason=str(e),
                )
            )
            raise

        # Issue capability if not provided (security: on-demand issuance)
        cap_string = token_req.cap
        if cap_string is None:
            cap_string = self.issue_capability(
                vault_session=request.vault_session,
                pii_ref=token_req.ref,
                pii_type=stored.pii_type,
                sink=request.sink,
                run=request.run,
                ttl_seconds=300,  # 5 minutes
            )

        # Verify capability (even if we just issued it - validates structure)
        self.cap_manager.verify(
            cap_string=cap_string,
            vault_session=request.vault_session,
            pii_ref=token_req.ref,
            sink=request.sink,
            run=request.run,
        )

        # Record disclosure
        self.policy_evaluator.record_disclosure(session, len(stored.value))

        # Add to result
        values[token_req.ref] = stored.value
        disclosed_types[stored.pii_type] = disclosed_types.get(stored.pii_type, 0) + 1

    # Audit
    event = create_resolve_event(
        vault_session=request.vault_session,
        run=request.run,
        sink_kind=request.sink.kind.value,
        sink_name=request.sink.name,
        disclosed=disclosed_types,
    )
    self.audit_logger.log_event(event)

    logger.info(
        "vault_resolve_complete",
        vault_session=request.vault_session,
        disclosed_count=len(values),
    )

    return ResolveResponse(
        values=values,
        audit_id=event.audit_id,
        disclosed=disclosed_types,
    )

resolve_tokens_in_args(args, vault_session, tool_name, run=None)

Extract tokens from arguments, validate policy, and return replacements.

This helper method handles both JSON and TEXT format tokens embedded in arguments, validates policy for each token, and returns the PII replacements that should be injected.

Parameters:

Name Type Description Default
args dict[str, Any]

Tool arguments that may contain tokens

required
vault_session str

Vault session ID

required
tool_name str

Name of the tool (for sink specification)

required
run RunContext | None

Run context (optional)

None

Returns:

Type Description
dict[str, str]

Tuple of (replacements, disclosed_types):

dict[PIIType, int]
  • replacements: Dict mapping token refs to actual PII values
tuple[dict[str, str], dict[PIIType, int]]
  • disclosed_types: Dict counting disclosures by PII type

Raises:

Type Description
PolicyDeniedError

If policy denies disclosure for any token

CapabilityInvalidError

If capability verification fails

Example

replacements, disclosed = vault.resolve_tokens_in_args( ... args={"to": {"$pii_ref": "tkn_abc", "type": "EMAIL"}}, ... vault_session="vs_123", ... tool_name="send_email", ... )

Source code in src/mcp_pvp/vault.py
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
def resolve_tokens_in_args(
    self,
    args: dict[str, Any],
    vault_session: str,
    tool_name: str,
    run: RunContext | None = None,
) -> tuple[dict[str, str], dict[PIIType, int]]:
    """
    Extract tokens from arguments, validate policy, and return replacements.

    This helper method handles both JSON and TEXT format tokens embedded in
    arguments, validates policy for each token, and returns the PII replacements
    that should be injected.

    Args:
        args: Tool arguments that may contain tokens
        vault_session: Vault session ID
        tool_name: Name of the tool (for sink specification)
        run: Run context (optional)

    Returns:
        Tuple of (replacements, disclosed_types):
        - replacements: Dict mapping token refs to actual PII values
        - disclosed_types: Dict counting disclosures by PII type

    Raises:
        PolicyDeniedError: If policy denies disclosure for any token
        CapabilityInvalidError: If capability verification fails

    Example:
        >>> replacements, disclosed = vault.resolve_tokens_in_args(
        ...     args={"to": {"$pii_ref": "tkn_abc", "type": "EMAIL"}},
        ...     vault_session="vs_123",
        ...     tool_name="send_email",
        ... )
    """
    # Get session
    session = self.store.get_session(vault_session)

    # Extract JSON tokens from args with their paths
    json_token_paths = extract_json_tokens(args)

    # Build replacements and verify
    replacements: dict[str, str] = {}
    disclosed_types: dict[PIIType, int] = {}

    # Process JSON format tokens
    for token, path in json_token_paths:
        # Extract just the top-level key from path (e.g., "to" from "to.nested")
        arg_path = path.split(".")[0] if path else None

        sink = Sink(
            kind=SinkKind.TOOL,
            name=tool_name,
            arg_path=arg_path,
        )

        # Get stored PII
        stored = self.store.get_pii(vault_session, token.pii_ref)

        # Verify capability if provided
        if token.cap:
            self.cap_manager.verify(
                cap_string=token.cap,
                vault_session=vault_session,
                pii_ref=token.pii_ref,
                sink=sink,
                run=run,
            )

        # Check policy
        try:
            self.policy_evaluator.check_disclosure(
                session=session,
                pii_type=stored.pii_type,
                sink=sink,
                run=run,
                value_size=len(stored.value),
            )
        except PolicyDeniedError as e:
            # Audit denial
            event = create_policy_denied_event(
                vault_session=vault_session,
                run=run,
                pii_type=stored.pii_type,
                sink_kind=sink.kind.value,
                sink_name=sink.name,
                reason=e.message,
            )
            self.audit_logger.log_event(event)
            raise

        # Record disclosure
        self.policy_evaluator.record_disclosure(session, len(stored.value))

        # Add to replacements
        replacements[token.pii_ref] = stored.value
        disclosed_types[stored.pii_type] = disclosed_types.get(stored.pii_type, 0) + 1

    # Process TEXT format tokens embedded in string arguments
    def extract_text_tokens_recursive(
        obj: Any, current_path: str = ""
    ) -> list[tuple[TextToken, str]]:
        """Recursively extract TEXT tokens from strings in data structure."""
        tokens_with_paths: list[tuple[TextToken, str]] = []

        if isinstance(obj, str):
            text_tokens = extract_text_tokens(obj)
            for text_token in text_tokens:
                tokens_with_paths.append((text_token, current_path))
        elif isinstance(obj, dict):
            for key, value in obj.items():
                new_path = f"{current_path}.{key}" if current_path else key
                tokens_with_paths.extend(extract_text_tokens_recursive(value, new_path))
        elif isinstance(obj, list):
            for idx, item in enumerate(obj):
                new_path = f"{current_path}[{idx}]"
                tokens_with_paths.extend(extract_text_tokens_recursive(item, new_path))

        return tokens_with_paths

    text_token_paths = extract_text_tokens_recursive(args)

    for text_token, path in text_token_paths:
        # Extract just the top-level key from path (strip array indices and nested paths)
        # e.g., "messages[0]" -> "messages", "config.nested.deep" -> "config"
        arg_path = path.split(".")[0].split("[")[0] if path else None

        sink = Sink(
            kind=SinkKind.TOOL,
            name=tool_name,
            arg_path=arg_path,
        )

        # Get stored PII
        stored = self.store.get_pii(vault_session, text_token.ref)

        # Check policy
        try:
            self.policy_evaluator.check_disclosure(
                session=session,
                pii_type=stored.pii_type,
                sink=sink,
                run=run,
                value_size=len(stored.value),
            )
        except PolicyDeniedError as e:
            # Audit denial
            event = create_policy_denied_event(
                vault_session=vault_session,
                run=run,
                pii_type=stored.pii_type,
                sink_kind=sink.kind.value,
                sink_name=sink.name,
                reason=e.message,
            )
            self.audit_logger.log_event(event)
            raise

        # Add to replacements and record disclosure (only for unique refs)
        if text_token.ref not in replacements:
            replacements[text_token.ref] = stored.value
            disclosed_types[stored.pii_type] = disclosed_types.get(stored.pii_type, 0) + 1
            # Record disclosure only once per unique token reference
            self.policy_evaluator.record_disclosure(session, len(stored.value))

    return replacements, disclosed_types

tokenize(request)

Tokenize content containing PII.

Parameters:

Name Type Description Default
request TokenizeRequest

TokenizeRequest

required

Returns:

Type Description
TokenizeResponse

TokenizeResponse with vault_session, redacted content, and tokens

Source code in src/mcp_pvp/vault.py
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
def tokenize(self, request: TokenizeRequest) -> TokenizeResponse:
    """
    Tokenize content containing PII.

    Args:
        request: TokenizeRequest

    Returns:
        TokenizeResponse with vault_session, redacted content, and tokens
    """
    logger.info(
        "vault_tokenize_start",
        content_length=len(request.content),
        token_format=request.token_format.value,
        workflow_run_id=request.run.workflow_run_id if request.run else None,
        step_id=request.run.step_id if request.run else None,
        vault_session=request.vault_session,
    )

    # Create or reuse vault session
    if request.vault_session:
        # Reuse existing session (e.g., for result tokenization)
        session = self.store.get_session(request.vault_session)
        logger.info(
            "vault_tokenize_reusing_session",
            vault_session=request.vault_session,
        )
    else:
        # Create new session
        session = self.store.create_session(ttl_seconds=request.session_ttl_seconds)

    # Detect PII
    detections = self.detector.detect(request.content, types=request.types)

    # Tokenize detections
    tokens: list[TextToken | JSONToken] = []
    token_replacements: list[tuple[int, int, str]] = []
    type_counts: dict[PIIType, int] = {}

    for detection in detections:
        # Store PII in vault
        stored = self.store.store_pii(
            session_id=session.session_id,
            pii_type=detection.pii_type.value,
            value=detection.text,
        )

        # Track type counts
        type_counts[detection.pii_type] = type_counts.get(detection.pii_type, 0) + 1

        # Create token
        token: TextToken | JSONToken
        if request.token_format == TokenFormat.TEXT:
            token = TextToken(ref=stored.ref, pii_type=detection.pii_type)
            token_str = token.to_text()
            tokens.append(token)
        else:  # JSON
            # SECURITY: Capabilities are NO LONGER issued during tokenization
            # They must be requested explicitly via vault.issue_capability()
            # after policy check in resolve/deliver operations.
            # This prevents capability reuse attacks.
            token = JSONToken(
                pii_ref=stored.ref,
                type=detection.pii_type,
                cap=None,  # No capability at tokenization time
            )
            token_str = f"{{{token.model_dump_json()}}}"  # Simplified JSON representation
            tokens.append(token)

        # Record replacement
        token_replacements.append((detection.start, detection.end, token_str))

    # Redact content
    redacted = redact_content(request.content, token_replacements)

    # Create response
    stats = TokenStats(
        detections=len(detections),
        tokens_created=len(tokens),
        types=type_counts,
    )

    # Audit
    event = create_tokenize_event(
        vault_session=session.session_id,
        run=request.run,
        detections=stats.detections,
        tokens_created=stats.tokens_created,
        types=stats.types,
        parent_audit_id=request.parent_audit_id,
    )
    self.audit_logger.log_event(event)

    logger.info(
        "vault_tokenize_complete",
        vault_session=session.session_id,
        detections=stats.detections,
        tokens_created=stats.tokens_created,
    )

    return TokenizeResponse(
        vault_session=session.session_id,
        redacted=redacted,
        tokens=tokens,
        stats=stats,
        expires_at=session.expires_at,
    )

tokenize_tool_result(tool_result, vault_session, run=None, parent_audit_id=None)

Tokenize tool result to prevent PII leakage while preserving structure.

This method detects PII in tool results and replaces it with tokens, preventing sensitive data from leaking back to the caller. It recursively traverses the result structure and replaces PII in string values while maintaining the original data types and structure.

Parameters:

Name Type Description Default
tool_result Any

The result from tool execution (any type)

required
vault_session str

Vault session ID for token storage

required
run RunContext | None

Run context (optional)

None
parent_audit_id str | None

Parent audit ID to link tokenization (optional)

None

Returns:

Type Description
Any

Tuple of (tokenized_result, result_tokens):

list[JSONToken | TextToken]
  • tokenized_result: Result with PII replaced by TEXT format tokens (same structure)
tuple[Any, list[JSONToken | TextToken]]
  • result_tokens: List of tokens found in the result
Example

result = {"email": "user@example.com", "status": "sent"} tokenized, tokens = vault.tokenize_tool_result( ... tool_result=result, ... vault_session="vs_123", ... )

tokenized contains: {"email": "[[PII:EMAIL:tkn_abc]]", "status": "sent"}

tokens contains: [TextToken(ref="tkn_abc", type=PIIType.EMAIL)]

Source code in src/mcp_pvp/vault.py
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
def tokenize_tool_result(
    self,
    tool_result: Any,
    vault_session: str,
    run: RunContext | None = None,
    parent_audit_id: str | None = None,
) -> tuple[Any, list[JSONToken | TextToken]]:
    """
    Tokenize tool result to prevent PII leakage while preserving structure.

    This method detects PII in tool results and replaces it with tokens,
    preventing sensitive data from leaking back to the caller. It recursively
    traverses the result structure and replaces PII in string values while
    maintaining the original data types and structure.

    Args:
        tool_result: The result from tool execution (any type)
        vault_session: Vault session ID for token storage
        run: Run context (optional)
        parent_audit_id: Parent audit ID to link tokenization (optional)

    Returns:
        Tuple of (tokenized_result, result_tokens):
        - tokenized_result: Result with PII replaced by TEXT format tokens (same structure)
        - result_tokens: List of tokens found in the result

    Example:
        >>> result = {"email": "user@example.com", "status": "sent"}
        >>> tokenized, tokens = vault.tokenize_tool_result(
        ...     tool_result=result,
        ...     vault_session="vs_123",
        ... )
        >>> # tokenized contains: {"email": "[[PII:EMAIL:tkn_abc]]", "status": "sent"}
        >>> # tokens contains: [TextToken(ref="tkn_abc", type=PIIType.EMAIL)]
    """
    if tool_result is None:
        return tool_result, []

    # Collect all tokens created during traversal
    all_tokens: list[JSONToken | TextToken] = []

    def tokenize_value_recursive(value: Any) -> Any:
        """Recursively tokenize PII in values while preserving structure."""
        # Handle None
        if value is None:
            return None

        # Handle strings - detect and replace PII
        if isinstance(value, str):
            # Tokenize the string content
            tokenization = self.tokenize(
                TokenizeRequest(
                    content=value,
                    vault_session=vault_session,
                    token_format=TokenFormat.TEXT,
                    run=run,
                    parent_audit_id=parent_audit_id,
                )
            )
            # Collect tokens
            all_tokens.extend(tokenization.tokens)
            # Return redacted string
            return tokenization.redacted

        # Handle dicts - recursively process values
        elif isinstance(value, dict):
            return {k: tokenize_value_recursive(v) for k, v in value.items()}

        # Handle lists - recursively process items
        elif isinstance(value, list):
            return [tokenize_value_recursive(item) for item in value]

        # Handle tuples - recursively process items, return as tuple
        elif isinstance(value, tuple):
            return tuple(tokenize_value_recursive(item) for item in value)

        # Handle sets - recursively process items, return as set
        elif isinstance(value, set):
            return {tokenize_value_recursive(item) for item in value}

        # Handle objects with __dict__ (like Pydantic models, custom classes)
        # This includes MCP's ContentBlock types
        elif hasattr(value, "__dict__") and hasattr(value, "__class__"):
            # For objects with attributes, we need to rebuild them
            # Get the object's dict representation
            obj_dict = {}
            for attr_name in dir(value):
                if not attr_name.startswith("_"):
                    try:
                        attr_value = getattr(value, attr_name)
                        # Skip methods
                        if not callable(attr_value):
                            obj_dict[attr_name] = attr_value
                    except Exception:
                        logger.exception(
                            "vault_tokenize_tool_result_attr_error",
                            attr_name=attr_name,
                            error=traceback.format_exc(),
                        )
                        continue

            # Tokenize the dict representation
            tokenized_dict = tokenize_value_recursive(obj_dict)

            # Try to reconstruct the object with tokenized values
            try:
                # For Pydantic models and similar, try to create new instance
                if hasattr(value.__class__, "model_validate"):
                    # Pydantic v2
                    return value.__class__.model_validate(tokenized_dict)
                elif hasattr(value.__class__, "parse_obj"):
                    # Pydantic v1
                    return value.__class__.parse_obj(tokenized_dict)
                else:
                    # For other types, try to use constructor
                    return value.__class__(**tokenized_dict)
            except Exception:
                # If reconstruction fails, return the tokenized dict
                return tokenized_dict

        # For other types (int, float, bool, etc.), return as-is
        # This includes numbers, booleans, dates, etc.
        else:
            return value

    # Tokenize the result recursively
    tokenized_result = tokenize_value_recursive(tool_result)

    return tokenized_result, all_tokens

Policy

Bases: BaseModel

PVP policy specification.

Source code in src/mcp_pvp/models.py
144
145
146
147
148
149
150
class Policy(BaseModel):
    """PVP policy specification."""

    sinks: dict[str, SinkPolicy] = Field(default_factory=dict)  # sink_id -> SinkPolicy
    defaults: SinkPolicy = Field(default_factory=lambda: SinkPolicy(allow=[]))
    limits: PolicyLimits = Field(default_factory=PolicyLimits)
    type_rules: dict[PIIType, dict[str, Any]] = Field(default_factory=dict)

PolicyAllow

Bases: BaseModel

Allow rule for a sink.

Source code in src/mcp_pvp/models.py
124
125
126
127
128
class PolicyAllow(BaseModel):
    """Allow rule for a sink."""

    type: PIIType
    arg_paths: list[str] | None = None  # If None, allow any arg_path

Requests and responses

TokenizeRequest

Bases: BaseModel

Request to tokenize content.

Source code in src/mcp_pvp/models.py
158
159
160
161
162
163
164
165
166
167
168
class TokenizeRequest(BaseModel):
    """Request to tokenize content."""

    content: str
    run: RunContext | None = None
    token_format: TokenFormat = TokenFormat.JSON
    include_caps: bool = True
    types: list[PIIType] | None = None  # If None, detect all types
    session_ttl_seconds: int = Field(default=3600, ge=60, le=86400)
    vault_session: str | None = None  # If provided, reuse existing session instead of creating new
    parent_audit_id: str | None = None  # If provided, link audit event to parent

TokenizeResponse

Bases: BaseModel

Response from tokenize operation.

Source code in src/mcp_pvp/models.py
179
180
181
182
183
184
185
186
class TokenizeResponse(BaseModel):
    """Response from tokenize operation."""

    vault_session: str
    redacted: str
    tokens: list[TextToken | JSONToken]
    stats: TokenStats
    expires_at: datetime

DeliverRequest

Bases: BaseModel

Request to deliver (inject and execute).

Source code in src/mcp_pvp/models.py
220
221
222
223
224
225
class DeliverRequest(BaseModel):
    """Request to deliver (inject and execute)."""

    vault_session: str
    tool_call: ToolCall
    run: RunContext | None = None

DeliverResponse

Bases: BaseModel

Response from deliver operation.

Source code in src/mcp_pvp/models.py
228
229
230
231
232
233
234
235
236
237
class DeliverResponse(BaseModel):
    """Response from deliver operation."""

    delivered: bool
    tool_result: Any = None  # Tokenized result from tool execution
    result_tokens: list[JSONToken | TextToken] = Field(
        default_factory=list
    )  # Tokens found in result
    audit_id: str
    error: str | None = None  # Scrubbed error message if delivery failed

ResolveRequest

Bases: BaseModel

Request to resolve tokens.

Source code in src/mcp_pvp/models.py
196
197
198
199
200
201
202
class ResolveRequest(BaseModel):
    """Request to resolve tokens."""

    vault_session: str
    tokens: list[ResolveTokenRequest]
    sink: Sink
    run: RunContext | None = None

ResolveResponse

Bases: BaseModel

Response from resolve operation.

Source code in src/mcp_pvp/models.py
205
206
207
208
209
210
class ResolveResponse(BaseModel):
    """Response from resolve operation."""

    values: dict[str, str]  # ref -> raw value
    audit_id: str
    disclosed: dict[PIIType, int]

Helpers and tooling

ToolCall

Bases: BaseModel

Tool call with arguments that may contain tokens.

Source code in src/mcp_pvp/models.py
213
214
215
216
217
class ToolCall(BaseModel):
    """Tool call with arguments that may contain tokens."""

    name: str
    args: dict[str, Any]

RunContext

Bases: BaseModel

Run context for correlation and audit.

Source code in src/mcp_pvp/models.py
45
46
47
48
49
50
class RunContext(BaseModel):
    """Run context for correlation and audit."""

    workflow_run_id: str | None = None
    step_id: str | None = None
    timestamp: datetime = Field(default_factory=utc_now)

VaultSession

Bases: BaseModel

Vault session containing tokenized PII.

Source code in src/mcp_pvp/models.py
102
103
104
105
106
107
108
109
110
class VaultSession(BaseModel):
    """Vault session containing tokenized PII."""

    session_id: str
    created_at: datetime = Field(default_factory=utc_now)
    expires_at: datetime
    tokens: dict[str, StoredPII] = Field(default_factory=dict)  # ref -> StoredPII
    disclosed_count: int = 0
    disclosed_bytes: int = 0