Skip to content

Commit 249938f

Browse files
pelleclaude
andcommitted
docs: Update README with new MCP resources documentation
Update README.md to document the new MCP resources added in v0.5.0: 1. Database Schema Resource (tap://database-schema) - Document new resource for accessing agent database schemas - Show query parameters and usage examples - Explain relationship to tap_get_database_schema tool 2. Enhanced TAP Schemas Resource (tap://schemas) - Document individual schema lookup capability - Show examples for specific message types (Transfer, Authorize, etc.) - Highlight v0.5.0 enhancements 3. Updated Examples - Add examples showing how to use the new resources - Include database schema and individual message schema lookups - Maintain consistency with existing documentation style 4. Resource Count Update - Update tool count from 29 to 34 tools - Update resource count to 6 total resources - Reflect current capabilities accurately 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 8a5636c commit 249938f

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed

tap-mcp/README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ TAP-MCP uses stdio transport, making it compatible with MCP clients like Claude
9393

9494
## Available Tools
9595

96-
TAP-MCP provides 29 comprehensive tools covering the complete TAP transaction lifecycle:
96+
TAP-MCP provides 34 comprehensive tools covering the complete TAP transaction lifecycle:
9797

9898
### Agent Management
9999

@@ -579,6 +579,8 @@ Views the raw content of a received message. Shows the complete raw message as r
579579

580580
## Available Resources
581581

582+
TAP-MCP provides 6 read-only resources for accessing TAP data without requiring tool calls:
583+
582584
### `tap://agents`
583585
Read-only access to agent information.
584586

@@ -612,13 +614,40 @@ tap://deliveries?limit=50&offset=100 # Pagination
612614
tap://deliveries/123 # Specific delivery record by ID
613615
```
614616

617+
### `tap://database-schema`
618+
**New in v0.5.0** - Access to database schema information for agent storage.
619+
620+
```
621+
tap://database-schema?agent_did=did:key:z6Mk... # Complete schema for agent's database (required)
622+
tap://database-schema?agent_did=did:key:z6Mk...&table_name=messages # Specific table schema
623+
```
624+
625+
Returns comprehensive database schema information including:
626+
- Table structures and column definitions
627+
- Index information and constraints
628+
- Row counts for each table
629+
- Database path and metadata
630+
631+
This resource provides the same information as the `tap_get_database_schema` tool but through the MCP resource interface, making it more appropriate for read-only data access.
632+
615633
### `tap://schemas`
616-
JSON schemas for TAP message types.
634+
JSON schemas for TAP message types with enhanced lookup capabilities.
617635

618636
```
619-
tap://schemas # All schemas
637+
tap://schemas # All TAP message schemas with version info
638+
tap://schemas/Transfer # Specific schema for Transfer message type
639+
tap://schemas/Authorize # Specific schema for Authorize message type
640+
tap://schemas/Reject # Specific schema for Reject message type
641+
tap://schemas/Settle # Specific schema for Settle message type
642+
tap://schemas/Cancel # Specific schema for Cancel message type
620643
```
621644

645+
**Enhanced in v0.5.0** with individual schema lookup:
646+
- Access specific message schemas by name (e.g., `Transfer`, `Authorize`)
647+
- Search by message type URL (e.g., `https://tap.rsvp/schema/1.0#Transfer`)
648+
- Includes comprehensive JSON schemas for all TAIP message types
649+
- Version information and TAIP specification references
650+
622651
### `tap://received`
623652
Access to raw received messages before processing.
624653

@@ -738,6 +767,15 @@ tap-mcp-client resource tap://deliveries?agent_did=did:key:z6MkpGuzuD38tpgZKPfmL
738767
# Check failed deliveries
739768
tap-mcp-client resource tap://deliveries?status=failed
740769

770+
# Get database schema for the agent
771+
tap-mcp-client resource tap://database-schema?agent_did=did:key:z6MkpGuzuD38tpgZKPfmLmmD8R6gihP9KJhuopMuVvfGzLmc
772+
773+
# Get schema for Transfer messages
774+
tap-mcp-client resource tap://schemas/Transfer
775+
776+
# Get all message schemas
777+
tap-mcp-client resource tap://schemas
778+
741779
# List customers that the agent represents
742780
echo '{"agent_did": "did:key:z6MkpGuzuD38tpgZKPfmLmmD8R6gihP9KJhuopMuVvfGzLmc"}' | \
743781
tap-mcp-client call tap_list_customers

0 commit comments

Comments
 (0)