Skip to content

Document tool definitions annotation support#515

Open
lujunsan wants to merge 4 commits intomainfrom
add-tool-definitions-annotation
Open

Document tool definitions annotation support#515
lujunsan wants to merge 4 commits intomainfrom
add-tool-definitions-annotation

Conversation

@lujunsan
Copy link
Contributor

@lujunsan lujunsan commented Feb 4, 2026

Summary

  • Document the new toolhive.stacklok.dev/tool-definitions annotation
  • Add example showing tool definitions in YAML annotations
  • Explain validation behavior, API response format, and supported fields

Related

Implements documentation for stacklok/toolhive-registry-server#414 (registry-server implementation of RFC-0015)

Changes

  • Updated docs/toolhive/guides-registry/configuration.mdx:
    • Added tool-definitions annotation to the annotations table
    • Included example tool definition in the registry YAML example
    • Added "Tool definitions format" section explaining:
      • JSON array format with MCP tool metadata fields
      • JSON syntax validation (registry) vs schema validation (operator)
      • API response location in publisher-provided metadata
      • Graceful error handling for invalid JSON

Signed-off-by: lujunsan <luisjuncaldev@gmail.com>
Copilot AI review requested due to automatic review settings February 4, 2026 00:41
@vercel
Copy link

vercel bot commented Feb 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Feb 4, 2026 1:10am

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR documents the new toolhive.stacklok.dev/tool-definitions annotation that allows registry users to specify MCP tool metadata directly in Kubernetes resource annotations. This feature enables tool discovery information to be embedded in the registry without requiring separate API calls.

Changes:

  • Added documentation for the tool-definitions annotation in the registry configuration guide
  • Included a YAML example showing how to specify tool definitions in annotations
  • Explained validation behavior, API response format, and supported metadata fields

Signed-off-by: lujunsan <luisjuncaldev@gmail.com>
@lujunsan
Copy link
Contributor Author

lujunsan commented Feb 4, 2026

@copilot re-review the changes after addressed feedback

@lujunsan
Copy link
Contributor Author

lujunsan commented Feb 4, 2026

@copilot re-review the changes in this PR, do not create a new PR nor attempt to do any code changes. Just re-review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Signed-off-by: lujunsan <luisjuncaldev@gmail.com>
Signed-off-by: lujunsan <luisjuncaldev@gmail.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@danbarr
Copy link
Collaborator

danbarr commented Feb 5, 2026

@lujunsan I'm not up to speed on this feature in the registry so it would be better if someone else from the team reviews this one.

@danbarr danbarr removed their request for review February 5, 2026 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants