@microsoft/agents-a365-tooling-extensions-openai 0.1.0-preview.30

package/README.md

@@ -0,0 +1,33 @@
+# @microsoft/agents-a365-tooling-extensions-openai
+
+[![npm](https://img.shields.io/npm/v/@microsoft/agents-a365-tooling-extensions-openai?label=npm&logo=npm)](https://www.npmjs.com/package/@microsoft/agents-a365-tooling-extensions-openai)
+[![npm Downloads](https://img.shields.io/npm/dm/@microsoft/agents-a365-tooling-extensions-openai?label=Downloads&logo=npm)](https://www.npmjs.com/package/@microsoft/agents-a365-tooling-extensions-openai)
+
+OpenAI Agents SDK integration for the Microsoft Agent 365 Tooling SDK. This package enables seamless integration of MCP (Model Context Protocol) tool servers with OpenAI Agents, providing automatic tool discovery and registration.
+
+## Installation
+
+```bash
+npm install @microsoft/agents-a365-tooling-extensions-openai
+```
+
+## Usage
+
+For detailed usage examples and implementation guidance, see the [Microsoft Agent 365 Tooling Documentation](https://learn.microsoft.com/microsoft-agent-365/developer/tooling?tabs=nodejs).
+
+## Support
+
+For issues, questions, or feedback:
+
+- File issues in the [GitHub Issues](https://github.com/microsoft/Agent365-nodejs/issues) section
+- See the [main documentation](../../README.md) for more information
+
+## Trademarks
+
+*Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.*
+
+## License
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+Licensed under the MIT License - see the [LICENSE](../../LICENSE.md) file for details

package/dist/cjs/McpToolRegistrationService.d.ts

@@ -0,0 +1,21 @@
+import { TurnContext, Authorization } from '@microsoft/agents-hosting';
+import { Agent } from '@openai/agents';
+/**
+ * Discover MCP servers and list tools formatted for the OpenAI Agents SDK.
+ * Uses listToolServers to fetch server configs.
+ */
+export declare class McpToolRegistrationService {
+    private configService;
+    /**
+     * Registers MCP tool servers and updates agent options with discovered tools and server configs.
+     * Call this to enable dynamic OpenAI tool access based on the current MCP environment.
+     * @param agent The OpenAI Agent instance to which MCP servers will be added.
+     * @param authorization Authorization object for token exchange.
+     * @param authHandlerName The name of the auth handler to use for token exchange.
+     * @param turnContext The TurnContext of the current request.
+     * @param authToken Optional bearer token for MCP server access.
+     * @returns The updated Agent instance with registered MCP servers.
+     */
+    addToolServersToAgent(agent: Agent, authorization: Authorization, authHandlerName: string, turnContext: TurnContext, authToken: string): Promise<Agent>;
+}
+//# sourceMappingURL=McpToolRegistrationService.d.ts.map

package/dist/cjs/McpToolRegistrationService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"McpToolRegistrationService.d.ts","sourceRoot":"","sources":["../../src/McpToolRegistrationService.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAGvE,OAAO,EAAE,KAAK,EAA2B,MAAM,gBAAgB,CAAC;AAEhE;;;GAGG;AACH,qBAAa,0BAA0B;IACrC,OAAO,CAAC,aAAa,CAA+E;IAGpG;;;;;;;;;OASG;IACG,qBAAqB,CACzB,KAAK,EAAE,KAAK,EACZ,aAAa,EAAE,aAAa,EAC5B,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,KAAK,CAAC;CAyClB"}

package/dist/cjs/McpToolRegistrationService.js

@@ -0,0 +1,62 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.McpToolRegistrationService = void 0;
+const agents_a365_tooling_1 = require("@microsoft/agents-a365-tooling");
+const agents_a365_runtime_1 = require("@microsoft/agents-a365-runtime");
+// OpenAI Agents SDK
+const agents_1 = require("@openai/agents");
+/**
+ * Discover MCP servers and list tools formatted for the OpenAI Agents SDK.
+ * Uses listToolServers to fetch server configs.
+ */
+class McpToolRegistrationService {
+    constructor() {
+        this.configService = new agents_a365_tooling_1.McpToolServerConfigurationService();
+    }
+    /**
+     * Registers MCP tool servers and updates agent options with discovered tools and server configs.
+     * Call this to enable dynamic OpenAI tool access based on the current MCP environment.
+     * @param agent The OpenAI Agent instance to which MCP servers will be added.
+     * @param authorization Authorization object for token exchange.
+     * @param authHandlerName The name of the auth handler to use for token exchange.
+     * @param turnContext The TurnContext of the current request.
+     * @param authToken Optional bearer token for MCP server access.
+     * @returns The updated Agent instance with registered MCP servers.
+     */
+    async addToolServersToAgent(agent, authorization, authHandlerName, turnContext, authToken) {
+        if (!agent) {
+            throw new Error('Agent is Required');
+        }
+        if (!authToken) {
+            authToken = await agents_a365_runtime_1.AgenticAuthenticationService.GetAgenticUserToken(authorization, authHandlerName, turnContext);
+        }
+        // Validate the authentication token
+        agents_a365_tooling_1.Utility.ValidateAuthToken(authToken);
+        const agenticAppId = agents_a365_runtime_1.Utility.ResolveAgentIdentity(turnContext, authToken);
+        const servers = await this.configService.listToolServers(agenticAppId, authToken);
+        const mcpServers = [];
+        for (const server of servers) {
+            // Compose headers if values are available
+            const headers = {};
+            if (authToken) {
+                headers['Authorization'] = `Bearer ${authToken}`;
+            }
+            // Create MCPServerStreamableHttp instance for OpenAI agents
+            const mcpServer = new agents_1.MCPServerStreamableHttp({
+                url: server.url,
+                name: server.mcpServerName,
+                requestInit: {
+                    headers: headers,
+                }
+            });
+            mcpServers.push(mcpServer);
+        }
+        agent.mcpServers = agent.mcpServers ?? [];
+        agent.mcpServers.push(...mcpServers);
+        return agent;
+    }
+}
+exports.McpToolRegistrationService = McpToolRegistrationService;
+//# sourceMappingURL=McpToolRegistrationService.js.map

package/dist/cjs/McpToolRegistrationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"McpToolRegistrationService.js","sourceRoot":"","sources":["../../src/McpToolRegistrationService.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,wEAA4F;AAC5F,wEAAyG;AAKzG,oBAAoB;AACpB,2CAAgE;AAEhE;;;GAGG;AACH,MAAa,0BAA0B;IAAvC;QACU,kBAAa,GAAuC,IAAI,uDAAiC,EAAE,CAAC;IA4DtG,CAAC;IAzDC;;;;;;;;;OASG;IACH,KAAK,CAAC,qBAAqB,CACzB,KAAY,EACZ,aAA4B,EAC5B,eAAuB,EACvB,WAAwB,EACxB,SAAiB;QAGjB,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS,GAAG,MAAM,kDAA4B,CAAC,mBAAmB,CAAC,aAAa,EAAE,eAAe,EAAE,WAAW,CAAC,CAAC;QAClH,CAAC;QAED,oCAAoC;QACpC,6BAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,6BAAc,CAAC,oBAAoB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACjF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAClF,MAAM,UAAU,GAA8B,EAAE,CAAC;QAEjD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,0CAA0C;YAC1C,MAAM,OAAO,GAA2B,EAAE,CAAC;YAC3C,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,SAAS,EAAE,CAAC;YACnD,CAAC;YAED,4DAA4D;YAC5D,MAAM,SAAS,GAAG,IAAI,gCAAuB,CAAC;gBAC5C,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,aAAa;gBAC1B,WAAW,EAAE;oBACX,OAAO,EAAE,OAAO;iBACjB;aACF,CAAC,CAAC;YAEH,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;QAED,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC;QAC1C,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;QAErC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA7DD,gEA6DC"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './McpToolRegistrationService';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./McpToolRegistrationService"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+DAA6C"}

package/dist/esm/McpToolRegistrationService.d.ts

@@ -0,0 +1,21 @@
+import { TurnContext, Authorization } from '@microsoft/agents-hosting';
+import { Agent } from '@openai/agents';
+/**
+ * Discover MCP servers and list tools formatted for the OpenAI Agents SDK.
+ * Uses listToolServers to fetch server configs.
+ */
+export declare class McpToolRegistrationService {
+    private configService;
+    /**
+     * Registers MCP tool servers and updates agent options with discovered tools and server configs.
+     * Call this to enable dynamic OpenAI tool access based on the current MCP environment.
+     * @param agent The OpenAI Agent instance to which MCP servers will be added.
+     * @param authorization Authorization object for token exchange.
+     * @param authHandlerName The name of the auth handler to use for token exchange.
+     * @param turnContext The TurnContext of the current request.
+     * @param authToken Optional bearer token for MCP server access.
+     * @returns The updated Agent instance with registered MCP servers.
+     */
+    addToolServersToAgent(agent: Agent, authorization: Authorization, authHandlerName: string, turnContext: TurnContext, authToken: string): Promise<Agent>;
+}
+//# sourceMappingURL=McpToolRegistrationService.d.ts.map

package/dist/esm/McpToolRegistrationService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"McpToolRegistrationService.d.ts","sourceRoot":"","sources":["../../src/McpToolRegistrationService.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAGvE,OAAO,EAAE,KAAK,EAA2B,MAAM,gBAAgB,CAAC;AAEhE;;;GAGG;AACH,qBAAa,0BAA0B;IACrC,OAAO,CAAC,aAAa,CAA+E;IAGpG;;;;;;;;;OASG;IACG,qBAAqB,CACzB,KAAK,EAAE,KAAK,EACZ,aAAa,EAAE,aAAa,EAC5B,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,KAAK,CAAC;CAyClB"}

package/dist/esm/McpToolRegistrationService.js

@@ -0,0 +1,58 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { McpToolServerConfigurationService, Utility } from '@microsoft/agents-a365-tooling';
+import { AgenticAuthenticationService, Utility as RuntimeUtility } from '@microsoft/agents-a365-runtime';
+// OpenAI Agents SDK
+import { MCPServerStreamableHttp } from '@openai/agents';
+/**
+ * Discover MCP servers and list tools formatted for the OpenAI Agents SDK.
+ * Uses listToolServers to fetch server configs.
+ */
+export class McpToolRegistrationService {
+    constructor() {
+        this.configService = new McpToolServerConfigurationService();
+    }
+    /**
+     * Registers MCP tool servers and updates agent options with discovered tools and server configs.
+     * Call this to enable dynamic OpenAI tool access based on the current MCP environment.
+     * @param agent The OpenAI Agent instance to which MCP servers will be added.
+     * @param authorization Authorization object for token exchange.
+     * @param authHandlerName The name of the auth handler to use for token exchange.
+     * @param turnContext The TurnContext of the current request.
+     * @param authToken Optional bearer token for MCP server access.
+     * @returns The updated Agent instance with registered MCP servers.
+     */
+    async addToolServersToAgent(agent, authorization, authHandlerName, turnContext, authToken) {
+        if (!agent) {
+            throw new Error('Agent is Required');
+        }
+        if (!authToken) {
+            authToken = await AgenticAuthenticationService.GetAgenticUserToken(authorization, authHandlerName, turnContext);
+        }
+        // Validate the authentication token
+        Utility.ValidateAuthToken(authToken);
+        const agenticAppId = RuntimeUtility.ResolveAgentIdentity(turnContext, authToken);
+        const servers = await this.configService.listToolServers(agenticAppId, authToken);
+        const mcpServers = [];
+        for (const server of servers) {
+            // Compose headers if values are available
+            const headers = {};
+            if (authToken) {
+                headers['Authorization'] = `Bearer ${authToken}`;
+            }
+            // Create MCPServerStreamableHttp instance for OpenAI agents
+            const mcpServer = new MCPServerStreamableHttp({
+                url: server.url,
+                name: server.mcpServerName,
+                requestInit: {
+                    headers: headers,
+                }
+            });
+            mcpServers.push(mcpServer);
+        }
+        agent.mcpServers = agent.mcpServers ?? [];
+        agent.mcpServers.push(...mcpServers);
+        return agent;
+    }
+}
+//# sourceMappingURL=McpToolRegistrationService.js.map

package/dist/esm/McpToolRegistrationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"McpToolRegistrationService.js","sourceRoot":"","sources":["../../src/McpToolRegistrationService.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,iCAAiC,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAC5F,OAAO,EAAE,4BAA4B,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAKzG,oBAAoB;AACpB,OAAO,EAAS,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEhE;;;GAGG;AACH,MAAM,OAAO,0BAA0B;IAAvC;QACU,kBAAa,GAAuC,IAAI,iCAAiC,EAAE,CAAC;IA4DtG,CAAC;IAzDC;;;;;;;;;OASG;IACH,KAAK,CAAC,qBAAqB,CACzB,KAAY,EACZ,aAA4B,EAC5B,eAAuB,EACvB,WAAwB,EACxB,SAAiB;QAGjB,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS,GAAG,MAAM,4BAA4B,CAAC,mBAAmB,CAAC,aAAa,EAAE,eAAe,EAAE,WAAW,CAAC,CAAC;QAClH,CAAC;QAED,oCAAoC;QACpC,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,cAAc,CAAC,oBAAoB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACjF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAClF,MAAM,UAAU,GAA8B,EAAE,CAAC;QAEjD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,0CAA0C;YAC1C,MAAM,OAAO,GAA2B,EAAE,CAAC;YAC3C,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,SAAS,EAAE,CAAC;YACnD,CAAC;YAED,4DAA4D;YAC5D,MAAM,SAAS,GAAG,IAAI,uBAAuB,CAAC;gBAC5C,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,aAAa;gBAC1B,WAAW,EAAE;oBACX,OAAO,EAAE,OAAO;iBACjB;aACF,CAAC,CAAC;YAEH,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;QAED,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC;QAC1C,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;QAErC,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export * from './McpToolRegistrationService';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './McpToolRegistrationService';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@microsoft/agents-a365-tooling-extensions-openai",
+  "version": "0.1.0-preview.30",
+  "description": "Agent 365 Tooling SDK for OpenAI for AI agents built with TypeScript/Node.js",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "scripts": {
+    "build:cjs": "npx tsc --project tsconfig.cjs.json",
+    "build:esm": "npx tsc --project tsconfig.esm.json",
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:watch": "npx tsc --watch",
+    "clean": "npx rimraf dist",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "prepublishOnly": "npm run clean && npm run build",
+    "ci": "npm ci",
+    "pack": "npm pack --pack-destination=../"
+  },
+  "keywords": [
+    "ai",
+    "agents",
+    "azure",
+    "typescript",
+    "openai"
+  ],
+  "author": "Microsoft Corporation",
+  "license": "See license file",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/Agent365-nodejs.git",
+    "directory": "packages/agents-a365-tooling-extensions-openai"
+  },
+  "dependencies": {
+    "@microsoft/agents-a365-tooling": "0.1.0-preview.30",
+    "@microsoft/agents-a365-runtime": "0.1.0-preview.30",
+    "@openai/agents": "*",
+    "@microsoft/agents-hosting": "*"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.0.0",
+    "jest": "^29.0.0",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.0.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "CHANGELOG.md"
+  ]
+}