mcp: unexport ToolFor (#402)
The rationale is provided on the issue. Also, document the low-level nature of Server.AddTool. (drive-by change) Fixes #401.
This commit is contained in:
parent
7769b2a959
commit
063fb12149
1 changed files with 16 additions and 26 deletions
|
|
@ -154,10 +154,18 @@ func (s *Server) RemovePrompts(names ...string) {
|
||||||
// If present, the output schema must also have type "object".
|
// If present, the output schema must also have type "object".
|
||||||
//
|
//
|
||||||
// When the handler is invoked as part of a CallTool request, req.Params.Arguments
|
// When the handler is invoked as part of a CallTool request, req.Params.Arguments
|
||||||
// will be a json.RawMessage. Unmarshaling the arguments and validating them against the
|
// will be a json.RawMessage.
|
||||||
// input schema are the handler author's responsibility.
|
|
||||||
//
|
//
|
||||||
// Most users should use the top-level function [AddTool].
|
// Unmarshaling the arguments and validating them against the input schema are the
|
||||||
|
// caller's responsibility.
|
||||||
|
//
|
||||||
|
// Validating the result against the output schema, if any, is the caller's responsibility.
|
||||||
|
//
|
||||||
|
// Setting the result's Content, StructuredContent and IsError fields are the caller's
|
||||||
|
// responsibility.
|
||||||
|
//
|
||||||
|
// Most users should use the top-level function [AddTool], which handles all these
|
||||||
|
// responsibilities.
|
||||||
func (s *Server) AddTool(t *Tool, h ToolHandler) {
|
func (s *Server) AddTool(t *Tool, h ToolHandler) {
|
||||||
if t.InputSchema == nil {
|
if t.InputSchema == nil {
|
||||||
// This prevents the tool author from forgetting to write a schema where
|
// This prevents the tool author from forgetting to write a schema where
|
||||||
|
|
@ -181,26 +189,6 @@ func (s *Server) AddTool(t *Tool, h ToolHandler) {
|
||||||
func() bool { s.tools.add(st); return true })
|
func() bool { s.tools.add(st); return true })
|
||||||
}
|
}
|
||||||
|
|
||||||
// ToolFor returns a shallow copy of t and a [ToolHandler] that wraps h.
|
|
||||||
//
|
|
||||||
// If the tool's input schema is nil, it is set to the schema inferred from the In
|
|
||||||
// type parameter, using [jsonschema.For]. The In type parameter must be a map
|
|
||||||
// or a struct, so that its inferred JSON Schema has type "object".
|
|
||||||
//
|
|
||||||
// For tools that don't return structured output, Out should be 'any'.
|
|
||||||
// Otherwise, if the tool's output schema is nil the output schema is set to
|
|
||||||
// the schema inferred from Out, which must be a map or a struct.
|
|
||||||
//
|
|
||||||
// Most users will call [AddTool]. Use [ToolFor] if you wish to modify the
|
|
||||||
// tool's schemas or wrap the ToolHandler before calling [Server.AddTool].
|
|
||||||
func ToolFor[In, Out any](t *Tool, h ToolHandlerFor[In, Out]) (*Tool, ToolHandler) {
|
|
||||||
tt, hh, err := toolForErr(t, h)
|
|
||||||
if err != nil {
|
|
||||||
panic(fmt.Sprintf("ToolFor: tool %q: %v", t.Name, err))
|
|
||||||
}
|
|
||||||
return tt, hh
|
|
||||||
}
|
|
||||||
|
|
||||||
// TODO(v0.3.0): test
|
// TODO(v0.3.0): test
|
||||||
func toolForErr[In, Out any](t *Tool, h ToolHandlerFor[In, Out]) (*Tool, ToolHandler, error) {
|
func toolForErr[In, Out any](t *Tool, h ToolHandlerFor[In, Out]) (*Tool, ToolHandler, error) {
|
||||||
tt := *t
|
tt := *t
|
||||||
|
|
@ -335,10 +323,12 @@ func setSchema[T any](sfield **jsonschema.Schema, rfield **jsonschema.Resolved)
|
||||||
// For tools that don't return structured output, Out should be 'any'.
|
// For tools that don't return structured output, Out should be 'any'.
|
||||||
// Otherwise, if the tool's output schema is nil the output schema is set to
|
// Otherwise, if the tool's output schema is nil the output schema is set to
|
||||||
// the schema inferred from Out, which must be a map or a struct.
|
// the schema inferred from Out, which must be a map or a struct.
|
||||||
//
|
|
||||||
// It is a convenience for s.AddTool(ToolFor(t, h)).
|
|
||||||
func AddTool[In, Out any](s *Server, t *Tool, h ToolHandlerFor[In, Out]) {
|
func AddTool[In, Out any](s *Server, t *Tool, h ToolHandlerFor[In, Out]) {
|
||||||
s.AddTool(ToolFor(t, h))
|
tt, hh, err := toolForErr(t, h)
|
||||||
|
if err != nil {
|
||||||
|
panic(fmt.Sprintf("AddTool: tool %q: %v", t.Name, err))
|
||||||
|
}
|
||||||
|
s.AddTool(tt, hh)
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoveTools removes the tools with the given names.
|
// RemoveTools removes the tools with the given names.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue