fix: ensure resource/template/list is marshalled safely

[SamMorrowDrums]

Fast follow to #54 to ensure that json is properly serialized for the resource/template/list endpoint, as the new URI Template class does not have Marshall/Unmarshall defined.

Summary by CodeRabbit

• New Features

  • Added the ability to list available resource templates through the updated server interface, allowing users to retrieve comprehensive template details.

• Refactor

  • Enhanced URI template handling with improved JSON serialization and deserialization for consistent, reliable data exchange.
  • Refined template matching logic and cleaned up unused dependencies to boost overall system stability.

[coderabbitai]

Walkthrough

The pull request refactors how URI templates are handled. It updates the resource template initialization to wrap the URI template in a pointer-based structure and introduces a new URITemplate type with custom JSON marshaling and unmarshaling. The change updates related method signatures and test cases, including the server’s template matching function, to use the new type. Additionally, it removes unnecessary imports where the old type was referenced.

Changes

Files	Change Summary
mcp/resources.go mcp/types.go	Updated the URI template handling by wrapping the template in a pointer-based structure. Introduced a new URITemplate type that embeds the original template and adds custom JSON marshaling/unmarshaling, and updated the ResourceTemplate field to use this new type.
server/server.go server/server_test.go	Changed the matchesTemplate function signature to use *mcp.URITemplate instead of *uritemplate.Template and removed the unused import. Updated test cases to validate resource template listing and reading, and removed prompt capability during server initialization.

Possibly related PRs

• Fix tool calls #38: Involves similar changes in the server functionality regarding handling of the URITemplate type.
• feat: support RFC 6570 for Resource Templates #54: Addresses changes to the URITemplate initialization in resource creation, aligning with the modifications in this PR.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8aa25c8 and d96fd20.

📒 Files selected for processing (4)

• mcp/resources.go (1 hunks)
• mcp/types.go (2 hunks)
• server/server.go (1 hunks)
• server/server_test.go (3 hunks)

🧰 Additional context used

🧬 Code Definitions (3)

mcp/resources.go (1)

mcp/types.go (1) (1)

• URITemplate (11:13)

server/server.go (1)

mcp/types.go (1) (1)

• URITemplate (11:13)

mcp/types.go (1)

mcp/tools.go (1) (1)

• t (82:104)

🔇 Additional comments (9)

mcp/types.go (4)

11-13: Nice introduction of the URITemplate type.

Good structural decision to embed uritemplate.Template within a new type. This provides a clean way to add custom marshaling/unmarshaling functionality while preserving the original template's behaviors.

---

15-17: Clean implementation of MarshalJSON method.

The MarshalJSON method correctly marshals the URI template by converting it to its raw string representation. This ensures proper JSON serialization of the template format.

---

19-30: Well-structured UnmarshalJSON implementation with proper error handling.

The UnmarshalJSON method correctly:

1. Unmarshal the JSON data into a string
2. Create a new template from that string
3. Handle potential errors during template creation
4. Assign the template to the struct

This ensures reliable deserialization of URI templates from JSON.

---

470-470: Appropriate field type update in ResourceTemplate struct.

The field type change from *uritemplate.Template to *URITemplate completes the integration of the new custom marshaling type throughout the codebase.

mcp/resources.go (1)

65-65: Template initialization updated correctly for the new URITemplate type.

The initialization now properly wraps the uritemplate.MustNew() result in the new URITemplate struct, maintaining the functionality while enabling the custom JSON marshaling.

server/server.go (1)

733-733: Function signature updated appropriately for the new URITemplate type.

The function parameter has been updated from *uritemplate.Template to *mcp.URITemplate, which is consistent with the type changes throughout the codebase. The function still works correctly because URITemplate embeds uritemplate.Template and inherits its methods.

server/server_test.go (3)

949-953: Test updated to include template list verification.

Good addition of the template list request to verify that the resources/templates/list endpoint is properly working with the new URI template structure.

---

955-990: Test flow enhancement with sequential API calls.

The test now properly tests both the listing of templates and reading a resource, providing better test coverage for the URI template changes.

---

977-986: Thorough validation of URI template marshaling.

Excellent addition of JSON serialization validation to ensure that the URITemplate is correctly marshalled to a string format in the JSON response. This directly tests the core functionality added in this PR.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.