using Microsoft.Extensions.AI;
using Microsoft.Extensions.DependencyInjection;
using ModelContextProtocol.Protocol;
using System.Text.Json;
namespace ModelContextProtocol.Server;
///
/// Used to indicate that a method should be considered an .
///
///
///
/// This attribute is applied to methods that should be exposed as tools in the Model Context Protocol. When a class
/// containing methods marked with this attribute is registered with ,
/// these methods become available as tools that can be called by MCP clients.
///
///
/// When methods are provided directly to , the attribute is not required.
///
///
/// By default, parameters are sourced from the dictionary, which is a collection
/// of key/value pairs, and are represented in the JSON schema for the function, as exposed in the returned 's
/// 's . Those parameters are deserialized from the
/// values in that collection. There are a few exceptions to this:
///
/// -
///
/// parameters are automatically bound to a provided by the
/// and that respects any s sent by the client for this operation's
/// . The parameter is not included in the generated JSON schema.
///
///
/// -
///
/// parameters are bound from the for this request,
/// and are not included in the JSON schema.
///
///
/// -
///
/// parameters are not included in the JSON schema and are bound directly to the
/// instance associated with this request's . Such parameters may be used to understand
/// what server is being used to process the request, and to interact with the client issuing the request to that server.
///
///
/// -
///
/// parameters accepting values
/// are not included in the JSON schema and are bound to an instance manufactured
/// to forward progress notifications from the tool to the client. If the client included a in their request,
/// progress reports issued to this instance will propagate to the client as notifications with
/// that token. If the client did not include a , the instance will ignore any progress reports issued to it.
///
///
/// -
///
/// When the is constructed, it may be passed an via
/// . Any parameter that can be satisfied by that
/// according to will not be included in the generated JSON schema and will be resolved
/// from the provided to when the tool is invoked rather than from the argument collection.
///
///
/// -
///
/// Any parameter attributed with will similarly be resolved from the
/// provided when the tool is invoked rather than from the argument
/// collection, and will not be included in the generated JSON schema.
///
///
///
///
///
/// All other parameters are deserialized from the s in the dictionary,
/// using the supplied in , or if none was provided,
/// using .
///
///
/// In general, the data supplied via the 's dictionary is passed along from the caller and
/// should thus be considered unvalidated and untrusted. To provide validated and trusted data to the invocation of the tool, consider having
/// the tool be an instance method, referring to data stored in the instance, or using an instance or parameters resolved from the
/// to provide data to the method.
///
///
/// Return values from a method are used to create the that is sent back to the client:
///
///
/// -
///
/// Returns an empty list.
///
/// -
///
/// Converted to a single object using .
///
/// -
///
/// Converted to a single object with set to the string value and set to "text".
///
/// -
///
/// Returned as a single-item list.
///
/// -
/// of
/// Each is converted to a object with set to the string value and set to "text".
///
/// -
/// of
/// Each is converted to a object using .
///
/// -
/// of
/// Returned as the list.
///
/// -
///
/// Returned directly without modification.
///
/// -
/// Other types
/// Serialized to JSON and returned as a single object with set to "text".
///
///
///
[AttributeUsage(AttributeTargets.Method)]
public sealed class McpServerToolAttribute : Attribute
{
// Defaults based on the spec
private const bool DestructiveDefault = true;
private const bool IdempotentDefault = false;
private const bool OpenWorldDefault = true;
private const bool ReadOnlyDefault = false;
// Nullable backing fields so we can distinguish
internal bool? _destructive;
internal bool? _idempotent;
internal bool? _openWorld;
internal bool? _readOnly;
///
/// Initializes a new instance of the class.
///
public McpServerToolAttribute()
{
}
/// Gets the name of the tool.
/// If , the method name will be used.
public string? Name { get; set; }
///
/// Gets or sets a human-readable title for the tool that can be displayed to users.
///
///
///
/// The title provides a more descriptive, user-friendly name for the tool than the tool's
/// programmatic name. It is intended for display purposes and to help users understand
/// the tool's purpose at a glance.
///
///
/// Unlike the tool name (which follows programmatic naming conventions), the title can
/// include spaces, special characters, and be phrased in a more natural language style.
///
///
public string? Title { get; set; }
///
/// Gets or sets whether the tool may perform destructive updates to its environment.
///
///
///
/// If , the tool may perform destructive updates to its environment.
/// If , the tool performs only additive updates.
/// This property is most relevant when the tool modifies its environment (ReadOnly = false).
///
///
/// The default is .
///
///
public bool Destructive
{
get => _destructive ?? DestructiveDefault;
set => _destructive = value;
}
///
/// Gets or sets whether calling the tool repeatedly with the same arguments
/// will have no additional effect on its environment.
///
///
///
/// This property is most relevant when the tool modifies its environment (ReadOnly = false).
///
///
/// The default is .
///
///
public bool Idempotent
{
get => _idempotent ?? IdempotentDefault;
set => _idempotent = value;
}
///
/// Gets or sets whether this tool may interact with an "open world" of external entities.
///
///
///
/// If , the tool may interact with an unpredictable or dynamic set of entities (like web search).
/// If , the tool's domain of interaction is closed and well-defined (like memory access).
///
///
/// The default is .
///
///
public bool OpenWorld
{
get => _openWorld ?? OpenWorldDefault;
set => _openWorld = value;
}
///
/// Gets or sets whether this tool does not modify its environment.
///
///
///
/// If , the tool only performs read operations without changing state.
/// If , the tool may make modifications to its environment.
///
///
/// Read-only tools do not have side effects beyond computational resource usage.
/// They don't create, update, or delete data in any system.
///
///
/// The default is .
///
///
public bool ReadOnly
{
get => _readOnly ?? ReadOnlyDefault;
set => _readOnly = value;
}
}