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 | |
__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 | |
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 | |
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 | |
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 | |
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 | |
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]
|
|
tuple[dict[str, str], dict[PIIType, int]]
|
|
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 | |
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 | |
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]
|
|
tuple[Any, list[JSONToken | TextToken]]
|
|
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 | |
Policy¶
Bases: BaseModel
PVP policy specification.
Source code in src/mcp_pvp/models.py
144 145 146 147 148 149 150 | |
PolicyAllow¶
Bases: BaseModel
Allow rule for a sink.
Source code in src/mcp_pvp/models.py
124 125 126 127 128 | |
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 | |
TokenizeResponse¶
Bases: BaseModel
Response from tokenize operation.
Source code in src/mcp_pvp/models.py
179 180 181 182 183 184 185 186 | |
DeliverRequest¶
Bases: BaseModel
Request to deliver (inject and execute).
Source code in src/mcp_pvp/models.py
220 221 222 223 224 225 | |
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 | |
ResolveRequest¶
Bases: BaseModel
Request to resolve tokens.
Source code in src/mcp_pvp/models.py
196 197 198 199 200 201 202 | |
ResolveResponse¶
Bases: BaseModel
Response from resolve operation.
Source code in src/mcp_pvp/models.py
205 206 207 208 209 210 | |
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 | |
RunContext¶
Bases: BaseModel
Run context for correlation and audit.
Source code in src/mcp_pvp/models.py
45 46 47 48 49 50 | |
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 | |