84cd6917bbCo-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: halter73 <54385+halter73@users.noreply.github.com> Co-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
113 lines
5.1 KiB
C#
113 lines
5.1 KiB
C#
using System.Diagnostics.CodeAnalysis;
|
|
|
|
namespace ModelContextProtocol;
|
|
|
|
/// <summary>
|
|
/// Defines diagnostic IDs, messages, and URLs for APIs annotated with <see cref="ExperimentalAttribute"/>.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Experimental diagnostic IDs are grouped by category:
|
|
/// <list type="bullet">
|
|
/// <item><description>
|
|
/// <c>MCPEXP001</c> covers APIs related to experimental features in the MCP specification itself,
|
|
/// such as Tasks and Extensions. These APIs may change as the specification evolves.
|
|
/// </description></item>
|
|
/// <item><description>
|
|
/// <c>MCPEXP002</c> covers experimental SDK APIs that are unrelated to the MCP specification,
|
|
/// such as subclassing internal types or SDK-specific extensibility hooks. These APIs may
|
|
/// change or be removed based on SDK design feedback.
|
|
/// </description></item>
|
|
/// </list>
|
|
/// <para>
|
|
/// When an experimental API is associated with an experimental specification, the message
|
|
/// should refer to the specification version that introduces the feature and the SEP
|
|
/// when available. If there is a SEP associated with the experimental API, the Url should
|
|
/// point to the SEP issue.
|
|
/// </para>
|
|
/// <para>
|
|
/// Experimental diagnostic IDs are in the format MCPEXP###.
|
|
/// </para>
|
|
/// <para>
|
|
/// Diagnostic IDs cannot be reused when experimental API are removed or promoted to stable.
|
|
/// This ensures that users do not suppress warnings for new diagnostics with existing
|
|
/// suppressions that might be left in place from prior uses of the same diagnostic ID.
|
|
/// </para>
|
|
/// </remarks>
|
|
internal static class Experimentals
|
|
{
|
|
/// <summary>
|
|
/// Diagnostic ID for the experimental MCP Tasks feature.
|
|
/// </summary>
|
|
public const string Tasks_DiagnosticId = "MCPEXP001";
|
|
|
|
/// <summary>
|
|
/// Message for the experimental MCP Tasks feature.
|
|
/// </summary>
|
|
public const string Tasks_Message = "The Tasks feature is experimental per the MCP specification and is subject to change.";
|
|
|
|
/// <summary>
|
|
/// URL for the experimental MCP Tasks feature.
|
|
/// </summary>
|
|
public const string Tasks_Url = "https://github.com/modelcontextprotocol/csharp-sdk/blob/main/docs/list-of-diagnostics.md#mcpexp001";
|
|
|
|
/// <summary>
|
|
/// Diagnostic ID for the experimental MCP Extensions feature.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This uses the same diagnostic ID as <see cref="Tasks_DiagnosticId"/> because both
|
|
/// Tasks and Extensions are covered by the same MCPEXP001 diagnostic for experimental
|
|
/// MCP features. Having separate constants improves code clarity while maintaining a
|
|
/// single diagnostic suppression point.
|
|
/// </remarks>
|
|
public const string Extensions_DiagnosticId = "MCPEXP001";
|
|
|
|
/// <summary>
|
|
/// Message for the experimental MCP Extensions feature.
|
|
/// </summary>
|
|
public const string Extensions_Message = "The Extensions feature is part of a future MCP specification version that has not yet been ratified and is subject to change.";
|
|
|
|
/// <summary>
|
|
/// URL for the experimental MCP Extensions feature.
|
|
/// </summary>
|
|
public const string Extensions_Url = "https://github.com/modelcontextprotocol/csharp-sdk/blob/main/docs/list-of-diagnostics.md#mcpexp001";
|
|
|
|
/// <summary>
|
|
/// Diagnostic ID for experimental SDK APIs unrelated to the MCP specification,
|
|
/// such as subclassing <c>McpClient</c>/<c>McpServer</c> or referencing <c>RunSessionHandler</c>.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This diagnostic ID covers experimental SDK-level extensibility APIs. All constants
|
|
/// in this group share the same diagnostic ID so users need only one suppression point
|
|
/// for SDK design preview features.
|
|
/// </remarks>
|
|
public const string Subclassing_DiagnosticId = "MCPEXP002";
|
|
|
|
/// <summary>
|
|
/// Message for experimental subclassing of McpClient and McpServer.
|
|
/// </summary>
|
|
public const string Subclassing_Message = "Subclassing McpClient and McpServer is experimental and subject to change.";
|
|
|
|
/// <summary>
|
|
/// URL for experimental subclassing of McpClient and McpServer.
|
|
/// </summary>
|
|
public const string Subclassing_Url = "https://github.com/modelcontextprotocol/csharp-sdk/blob/main/docs/list-of-diagnostics.md#mcpexp002";
|
|
|
|
/// <summary>
|
|
/// Diagnostic ID for the experimental <c>RunSessionHandler</c> API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This uses the same diagnostic ID as <see cref="Subclassing_DiagnosticId"/> because
|
|
/// both are experimental SDK APIs unrelated to the MCP specification.
|
|
/// </remarks>
|
|
public const string RunSessionHandler_DiagnosticId = "MCPEXP002";
|
|
|
|
/// <summary>
|
|
/// Message for the experimental <c>RunSessionHandler</c> API.
|
|
/// </summary>
|
|
public const string RunSessionHandler_Message = "RunSessionHandler is experimental and may be removed or changed in a future release. Consider using ConfigureSessionOptions instead.";
|
|
|
|
/// <summary>
|
|
/// URL for the experimental <c>RunSessionHandler</c> API.
|
|
/// </summary>
|
|
public const string RunSessionHandler_Url = "https://github.com/modelcontextprotocol/csharp-sdk/blob/main/docs/list-of-diagnostics.md#mcpexp002";
|
|
}
|