@fgv/ts-extras-mcp 5.1.0-36 → 5.1.0-39

package/temp/ts-extras-mcp.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.58.7",
+    "toolVersion": "7.58.9",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -1388,6 +1388,159 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolAnnotations:interface",
+          "docComment": "/**\n * Normalized MCP `Tool.annotations` — the five known host-advisory behavior hints.\n *\n * @remarks\n *\n * Field names mirror MCP's `ToolAnnotations` 1:1 (and map straight onto `AiAssist.IAiToolAnnotations`). Per the MCP spec these are hints only, and per the untrusted-server warning they are validated/normalized (known fields kept, malformed or unknown fields dropped) before they reach {@link IMcpToolDescriptor} — the raw server blob is never propagated.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface IMcpToolAnnotations "
+            }
+          ],
+          "fileUrlPath": "src/packlets/mcp/model.ts",
+          "releaseTag": "Public",
+          "name": "IMcpToolAnnotations",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolAnnotations#destructiveHint:member",
+              "docComment": "/**\n * Hint: the tool may perform destructive updates (only meaningful when not read-only).\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly destructiveHint?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "destructiveHint",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolAnnotations#idempotentHint:member",
+              "docComment": "/**\n * Hint: repeated calls with the same arguments have no additional effect.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly idempotentHint?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "idempotentHint",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolAnnotations#openWorldHint:member",
+              "docComment": "/**\n * Hint: the tool interacts with an open world of external entities.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly openWorldHint?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "openWorldHint",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolAnnotations#readOnlyHint:member",
+              "docComment": "/**\n * Hint: the tool does not modify its environment (read-only).\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly readOnlyHint?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "readOnlyHint",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolAnnotations#title:member",
+              "docComment": "/**\n * Optional human-readable display title for the tool.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly title?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "title",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolCallResult:interface",
@@ -1448,6 +1601,34 @@
           "name": "IMcpToolDescriptor",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolDescriptor#annotations:member",
+              "docComment": "/**\n * The tool's normalized behavior annotations, when the server provided any usable ones. Absent when the server declared no annotations (or only malformed/unknown fields). See {@link IMcpToolAnnotations}.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly annotations?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IMcpToolAnnotations",
+                  "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolAnnotations:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "annotations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@fgv/ts-extras-mcp!IMcpToolDescriptor#description:member",

package/temp/ts-extras-mcp.api.md

@@ -81,6 +81,15 @@ export interface IMcpStdioTransportParams {
     readonly env?: Record<string, string>;
 }
 
+// @public
+export interface IMcpToolAnnotations {
+    readonly destructiveHint?: boolean;
+    readonly idempotentHint?: boolean;
+    readonly openWorldHint?: boolean;
+    readonly readOnlyHint?: boolean;
+    readonly title?: string;
+}
+
 // @public
 export interface IMcpToolCallResult {
     readonly content: string;
@@ -88,6 +97,7 @@ export interface IMcpToolCallResult {
 
 // @public
 export interface IMcpToolDescriptor {
+    readonly annotations?: IMcpToolAnnotations;
     readonly description: string | undefined;
     readonly inputSchema: JsonValue;
     readonly name: string;