Skip to content

Document tool definitions annotation support#515

Merged
rdimitrov merged 4 commits into
mainfrom
add-tool-definitions-annotation
Feb 10, 2026
Merged

Document tool definitions annotation support#515
rdimitrov merged 4 commits into
mainfrom
add-tool-definitions-annotation

Conversation

@lujunsan

@lujunsan lujunsan commented Feb 4, 2026

Copy link
Copy Markdown
Contributor

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

vercel Bot commented Feb 4, 2026

Copy link
Copy Markdown

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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

Comment thread docs/toolhive/guides-registry/configuration.mdx
Comment thread docs/toolhive/guides-registry/configuration.mdx Outdated
Comment thread docs/toolhive/guides-registry/configuration.mdx Outdated
Signed-off-by: lujunsan <luisjuncaldev@gmail.com>
@lujunsan

lujunsan commented Feb 4, 2026

Copy link
Copy Markdown
Contributor Author

@copilot re-review the changes after addressed feedback

@lujunsan

lujunsan commented Feb 4, 2026

Copy link
Copy Markdown
Contributor Author

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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.

Comment thread docs/toolhive/guides-registry/configuration.mdx Outdated
Signed-off-by: lujunsan <luisjuncaldev@gmail.com>
Signed-off-by: lujunsan <luisjuncaldev@gmail.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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

danbarr commented Feb 5, 2026

Copy link
Copy Markdown
Collaborator

@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
@rdimitrov rdimitrov merged commit 2a54c41 into main Feb 10, 2026
9 checks passed
@rdimitrov rdimitrov deleted the add-tool-definitions-annotation branch February 10, 2026 00:00
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.

4 participants