add tools section to readme

[ianjkaplan]

Add AI Tools Plugin

TL;DR

Added a new AI tools plugin that generates structured tool definitions from OpenAPI operations for integration with AI systems that support tool calling.

What changed?

• Added documentation for the new AI tools plugin in the README
• Included features of the AI tools plugin:
  • Generates tool definitions for each OpenAPI operation
  • Uses Zod schemas for parameter validation
  • Compatible with OpenAI function calling format
  • Maintains type safety with TypeScript types
  • Includes operation descriptions as tool documentation
• Added installation instructions for the required @openai/agents package
• Added usage example showing how to configure and use the tools plugin
• Updated the configuration example to include the tools plugin

How to test?

1. Install the required dependency:

   pnpm install @openai/agents

2. Add the tools plugin to your configuration:

   import { tools } from "@pushpress/openapi-ts-plugins";
   
   export default defineConfig({
     // ...
     plugins: [
       // ...
       tools.defineConfig(),
     ],
   });

3. Import and use the generated tools with OpenAI's agent:

   import { getUserTool, createUserTool } from "./client/tools";
   import { Agent } from "@openai/agents";
   
   const agent = new Agent({
     name: "Travel assistant",
     tools: [tool(getUserTool), tool(createUserTool)],
   });

Why make this change?

This plugin makes it easier to integrate OpenAPI-defined APIs with AI systems that support tool calling, such as OpenAI's function calling. By automatically generating structured tool definitions from OpenAPI operations, developers can quickly enable their APIs to be used by AI agents without manual schema definition work.

[ianjkaplan]

• add tools section to readme #12 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.