many: minor cosmetic changes (#529)
This commit is contained in:
parent
b9c1419ab0
commit
5f05f8a43a
14 changed files with 21 additions and 21 deletions
|
|
@ -33,7 +33,7 @@ The SDK consists of several importable packages:
|
||||||
their own transports.
|
their own transports.
|
||||||
- The
|
- The
|
||||||
[`github.com/modelcontextprotocol/go-sdk/auth`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/auth)
|
[`github.com/modelcontextprotocol/go-sdk/auth`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/auth)
|
||||||
package provides some primitives for supporting oauth.
|
package provides some primitives for supporting OAuth.
|
||||||
- The
|
- The
|
||||||
[`github.com/modelcontextprotocol/go-sdk/oauthex`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/oauthex)
|
[`github.com/modelcontextprotocol/go-sdk/oauthex`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/oauthex)
|
||||||
package provides extensions to the OAuth protocol, such as ProtectedResourceMetadata.
|
package provides extensions to the OAuth protocol, such as ProtectedResourceMetadata.
|
||||||
|
|
@ -78,7 +78,7 @@ func main() {
|
||||||
// Create a server with a single tool.
|
// Create a server with a single tool.
|
||||||
server := mcp.NewServer(&mcp.Implementation{Name: "greeter", Version: "v1.0.0"}, nil)
|
server := mcp.NewServer(&mcp.Implementation{Name: "greeter", Version: "v1.0.0"}, nil)
|
||||||
mcp.AddTool(server, &mcp.Tool{Name: "greet", Description: "say hi"}, SayHi)
|
mcp.AddTool(server, &mcp.Tool{Name: "greet", Description: "say hi"}, SayHi)
|
||||||
// Run the server over stdin/stdout, until the client disconnects
|
// Run the server over stdin/stdout, until the client disconnects.
|
||||||
if err := server.Run(context.Background(), &mcp.StdioTransport{}); err != nil {
|
if err := server.Run(context.Background(), &mcp.StdioTransport{}); err != nil {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
@ -106,7 +106,7 @@ func main() {
|
||||||
// Create a new client, with no features.
|
// Create a new client, with no features.
|
||||||
client := mcp.NewClient(&mcp.Implementation{Name: "mcp-client", Version: "v1.0.0"}, nil)
|
client := mcp.NewClient(&mcp.Implementation{Name: "mcp-client", Version: "v1.0.0"}, nil)
|
||||||
|
|
||||||
// Connect to a server over stdin/stdout
|
// Connect to a server over stdin/stdout.
|
||||||
transport := &mcp.CommandTransport{Command: exec.Command("myserver")}
|
transport := &mcp.CommandTransport{Command: exec.Command("myserver")}
|
||||||
session, err := client.Connect(ctx, transport, nil)
|
session, err := client.Connect(ctx, transport, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
||||||
|
|
@ -56,8 +56,6 @@ func TokenInfoFromContext(ctx context.Context) *TokenInfo {
|
||||||
// If verification succeeds, the [TokenInfo] is added to the request's context and the request proceeds.
|
// If verification succeeds, the [TokenInfo] is added to the request's context and the request proceeds.
|
||||||
// If verification fails, the request fails with a 401 Unauthenticated, and the WWW-Authenticate header
|
// If verification fails, the request fails with a 401 Unauthenticated, and the WWW-Authenticate header
|
||||||
// is populated to enable [protected resource metadata].
|
// is populated to enable [protected resource metadata].
|
||||||
//
|
|
||||||
|
|
||||||
//
|
//
|
||||||
// [protected resource metadata]: https://datatracker.ietf.org/doc/rfc9728
|
// [protected resource metadata]: https://datatracker.ietf.org/doc/rfc9728
|
||||||
func RequireBearerToken(verifier TokenVerifier, opts *RequireBearerTokenOptions) func(http.Handler) http.Handler {
|
func RequireBearerToken(verifier TokenVerifier, opts *RequireBearerTokenOptions) func(http.Handler) http.Handler {
|
||||||
|
|
|
||||||
|
|
@ -16,8 +16,8 @@ type ID struct {
|
||||||
value any
|
value any
|
||||||
}
|
}
|
||||||
|
|
||||||
// MakeID coerces the given Go value to an ID. The value is assumed to be the
|
// MakeID coerces the given Go value to an ID. The value should be the
|
||||||
// default JSON marshaling of a Request identifier -- nil, float64, or string.
|
// default JSON marshaling of a Request identifier: nil, float64, or string.
|
||||||
//
|
//
|
||||||
// Returns an error if the value type was not a valid Request ID type.
|
// Returns an error if the value type was not a valid Request ID type.
|
||||||
//
|
//
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,7 @@ The SDK consists of several importable packages:
|
||||||
their own transports.
|
their own transports.
|
||||||
- The
|
- The
|
||||||
[`github.com/modelcontextprotocol/go-sdk/auth`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/auth)
|
[`github.com/modelcontextprotocol/go-sdk/auth`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/auth)
|
||||||
package provides some primitives for supporting oauth.
|
package provides some primitives for supporting OAuth.
|
||||||
- The
|
- The
|
||||||
[`github.com/modelcontextprotocol/go-sdk/oauthex`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/oauthex)
|
[`github.com/modelcontextprotocol/go-sdk/oauthex`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/oauthex)
|
||||||
package provides extensions to the OAuth protocol, such as ProtectedResourceMetadata.
|
package provides extensions to the OAuth protocol, such as ProtectedResourceMetadata.
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,7 @@ func main() {
|
||||||
// Create a new client, with no features.
|
// Create a new client, with no features.
|
||||||
client := mcp.NewClient(&mcp.Implementation{Name: "mcp-client", Version: "v1.0.0"}, nil)
|
client := mcp.NewClient(&mcp.Implementation{Name: "mcp-client", Version: "v1.0.0"}, nil)
|
||||||
|
|
||||||
// Connect to a server over stdin/stdout
|
// Connect to a server over stdin/stdout.
|
||||||
transport := &mcp.CommandTransport{Command: exec.Command("myserver")}
|
transport := &mcp.CommandTransport{Command: exec.Command("myserver")}
|
||||||
session, err := client.Connect(ctx, transport, nil)
|
session, err := client.Connect(ctx, transport, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,7 @@ func main() {
|
||||||
// Create a server with a single tool.
|
// Create a server with a single tool.
|
||||||
server := mcp.NewServer(&mcp.Implementation{Name: "greeter", Version: "v1.0.0"}, nil)
|
server := mcp.NewServer(&mcp.Implementation{Name: "greeter", Version: "v1.0.0"}, nil)
|
||||||
mcp.AddTool(server, &mcp.Tool{Name: "greet", Description: "say hi"}, SayHi)
|
mcp.AddTool(server, &mcp.Tool{Name: "greet", Description: "say hi"}, SayHi)
|
||||||
// Run the server over stdin/stdout, until the client disconnects
|
// Run the server over stdin/stdout, until the client disconnects.
|
||||||
if err := server.Run(context.Background(), &mcp.StdioTransport{}); err != nil {
|
if err := server.Run(context.Background(), &mcp.StdioTransport{}); err != nil {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -19,8 +19,8 @@ type (
|
||||||
Response = jsonrpc2.Response
|
Response = jsonrpc2.Response
|
||||||
)
|
)
|
||||||
|
|
||||||
// MakeID coerces the given Go value to an ID. The value is assumed to be the
|
// MakeID coerces the given Go value to an ID. The value should be the
|
||||||
// default JSON marshaling of a Request identifier -- nil, float64, or string.
|
// default JSON marshaling of a Request identifier: nil, float64, or string.
|
||||||
//
|
//
|
||||||
// Returns an error if the value type was not a valid Request ID type.
|
// Returns an error if the value type was not a valid Request ID type.
|
||||||
func MakeID(v any) (ID, error) {
|
func MakeID(v any) (ID, error) {
|
||||||
|
|
|
||||||
|
|
@ -668,7 +668,7 @@ func (cs *ClientSession) callProgressNotificationHandler(ctx context.Context, pa
|
||||||
// NotifyProgress sends a progress notification from the client to the server
|
// NotifyProgress sends a progress notification from the client to the server
|
||||||
// associated with this session.
|
// associated with this session.
|
||||||
// This can be used if the client is performing a long-running task that was
|
// This can be used if the client is performing a long-running task that was
|
||||||
// initiated by the server
|
// initiated by the server.
|
||||||
func (cs *ClientSession) NotifyProgress(ctx context.Context, params *ProgressNotificationParams) error {
|
func (cs *ClientSession) NotifyProgress(ctx context.Context, params *ProgressNotificationParams) error {
|
||||||
return handleNotify(ctx, notificationProgress, newClientRequest(cs, orZero[Params](params)))
|
return handleNotify(ctx, notificationProgress, newClientRequest(cs, orZero[Params](params)))
|
||||||
}
|
}
|
||||||
|
|
@ -701,7 +701,7 @@ func (cs *ClientSession) Resources(ctx context.Context, params *ListResourcesPar
|
||||||
|
|
||||||
// ResourceTemplates provides an iterator for all resource templates available on the server,
|
// ResourceTemplates provides an iterator for all resource templates available on the server,
|
||||||
// automatically fetching pages and managing cursors.
|
// automatically fetching pages and managing cursors.
|
||||||
// The `params` argument can set the initial cursor.
|
// The params argument can set the initial cursor.
|
||||||
// Iteration stops at the first encountered error, which will be yielded.
|
// Iteration stops at the first encountered error, which will be yielded.
|
||||||
func (cs *ClientSession) ResourceTemplates(ctx context.Context, params *ListResourceTemplatesParams) iter.Seq2[*ResourceTemplate, error] {
|
func (cs *ClientSession) ResourceTemplates(ctx context.Context, params *ListResourceTemplatesParams) iter.Seq2[*ResourceTemplate, error] {
|
||||||
if params == nil {
|
if params == nil {
|
||||||
|
|
|
||||||
|
|
@ -189,7 +189,7 @@ type ResourceContents struct {
|
||||||
Meta Meta `json:"_meta,omitempty"`
|
Meta Meta `json:"_meta,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r ResourceContents) MarshalJSON() ([]byte, error) {
|
func (r *ResourceContents) MarshalJSON() ([]byte, error) {
|
||||||
// If we could assume Go 1.24, we could use omitzero for Blob and avoid this method.
|
// If we could assume Go 1.24, we could use omitzero for Blob and avoid this method.
|
||||||
if r.URI == "" {
|
if r.URI == "" {
|
||||||
return nil, errors.New("ResourceContents missing URI")
|
return nil, errors.New("ResourceContents missing URI")
|
||||||
|
|
@ -197,7 +197,7 @@ func (r ResourceContents) MarshalJSON() ([]byte, error) {
|
||||||
if r.Blob == nil {
|
if r.Blob == nil {
|
||||||
// Text. Marshal normally.
|
// Text. Marshal normally.
|
||||||
type wireResourceContents ResourceContents // (lacks MarshalJSON method)
|
type wireResourceContents ResourceContents // (lacks MarshalJSON method)
|
||||||
return json.Marshal((wireResourceContents)(r))
|
return json.Marshal((wireResourceContents)(*r))
|
||||||
}
|
}
|
||||||
// Blob.
|
// Blob.
|
||||||
if r.Text != "" {
|
if r.Text != "" {
|
||||||
|
|
|
||||||
|
|
@ -176,7 +176,6 @@ type EventStore interface {
|
||||||
// with all of its streams.
|
// with all of its streams.
|
||||||
// A store cannot rely on this method being called for cleanup. It should institute
|
// A store cannot rely on this method being called for cleanup. It should institute
|
||||||
// additional mechanisms, such as timeouts, to reclaim storage.
|
// additional mechanisms, such as timeouts, to reclaim storage.
|
||||||
//
|
|
||||||
SessionClosed(_ context.Context, sessionID string) error
|
SessionClosed(_ context.Context, sessionID string) error
|
||||||
|
|
||||||
// There is no StreamClosed method. A server doesn't know when a stream is finished, because
|
// There is no StreamClosed method. A server doesn't know when a stream is finished, because
|
||||||
|
|
|
||||||
|
|
@ -18,7 +18,7 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
// Optional annotations for the client. The client can use annotations to inform
|
// Optional annotations for the client. The client can use annotations to inform
|
||||||
// how objects are used or displayed
|
// how objects are used or displayed.
|
||||||
type Annotations struct {
|
type Annotations struct {
|
||||||
// Describes who the intended customer of this object or data is.
|
// Describes who the intended customer of this object or data is.
|
||||||
//
|
//
|
||||||
|
|
|
||||||
|
|
@ -27,6 +27,7 @@ import (
|
||||||
"github.com/yosida95/uritemplate/v3"
|
"github.com/yosida95/uritemplate/v3"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// DefaultPageSize is the default for [ServerOptions.PageSize].
|
||||||
const DefaultPageSize = 1000
|
const DefaultPageSize = 1000
|
||||||
|
|
||||||
// A Server is an instance of an MCP server.
|
// A Server is an instance of an MCP server.
|
||||||
|
|
|
||||||
|
|
@ -453,13 +453,13 @@ func clientRequestFor[P Params](s *ClientSession, p P) *ClientRequest[P] {
|
||||||
|
|
||||||
// Params is a parameter (input) type for an MCP call or notification.
|
// Params is a parameter (input) type for an MCP call or notification.
|
||||||
type Params interface {
|
type Params interface {
|
||||||
// isParams discourages implementation of Params outside of this package.
|
|
||||||
isParams()
|
|
||||||
|
|
||||||
// GetMeta returns metadata from a value.
|
// GetMeta returns metadata from a value.
|
||||||
GetMeta() map[string]any
|
GetMeta() map[string]any
|
||||||
// SetMeta sets the metadata on a value.
|
// SetMeta sets the metadata on a value.
|
||||||
SetMeta(map[string]any)
|
SetMeta(map[string]any)
|
||||||
|
|
||||||
|
// isParams discourages implementation of Params outside of this package.
|
||||||
|
isParams()
|
||||||
}
|
}
|
||||||
|
|
||||||
// RequestParams is a parameter (input) type for an MCP request.
|
// RequestParams is a parameter (input) type for an MCP request.
|
||||||
|
|
|
||||||
|
|
@ -7,4 +7,6 @@ package oauthex
|
||||||
|
|
||||||
import "github.com/modelcontextprotocol/go-sdk/internal/oauthex"
|
import "github.com/modelcontextprotocol/go-sdk/internal/oauthex"
|
||||||
|
|
||||||
|
// ProtectedResourceMetadata is the metadata for an OAuth 2.0 protected resource,
|
||||||
|
// as defined in section 2 of https://www.rfc-editor.org/rfc/rfc9728.html.
|
||||||
type ProtectedResourceMetadata = oauthex.ProtectedResourceMetadata
|
type ProtectedResourceMetadata = oauthex.ProtectedResourceMetadata
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue