chatgpt-api/packages/tool-client
Travis Fischer bc2c1e34fd chore: release v8.4.2 2025-07-03 06:20:43 -05:00
..
src feat: TS SDK docs and small fixes 2025-06-29 08:31:37 -05:00
package.json chore: release v8.4.2 2025-07-03 06:20:43 -05:00
readme.md fix: make readme images fully qualified urls so npm readmes don't 404 on them 2025-06-30 12:59:49 -05:00
tsconfig.json feat: add tool-client and search example; refactor e2e 2025-06-24 07:34:22 -05:00

readme.md

Agentic

Build Status NPM Prettier Code Formatting

@agentic/platform-tool-client

Main client for working with LLM tools hosted on the Agentic platform.

The purpose of this package is to connect TypeScript LLM SDKs to Agentic's hosted tools via the AgenticToolClient.fromIdentifier(...) method.

Install

npm i @agentic/platform-tool-client

Usage

This example uses the Vercel AI SDK and the @agentic/search tool.

import 'dotenv/config'

import { createAISDKTools } from '@agentic/ai-sdk'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { createOpenAI } from '@ai-sdk/openai'
import { generateText } from 'ai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
  const openai = createOpenAI({ compatibility: 'strict' })

  const result = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(searchTool),
    toolChoice: 'required',
    temperature: 0,
    system: 'You are a helpful assistant. Be as concise as possible.',
    prompt: 'What is the weather in San Francisco?'
  })

  console.log(JSON.stringify(result.toolResults[0], null, 2))
}

await main()

If you have a subscription to the Agentic project, you can specify your API key either by using the AGENTIC_API_KEY environment variable, or by passing it explicitly:

const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search', {
  apiKey: process.env.AGENTIC_API_KEY
})

Now all tool calls will be associated with your subscription for usage-tracking and billing purposes.

Docs

See the Agentic Quick Start for more details on how to use Agentic tools with other TS LLM SDKs, MCP clients, and simple HTTP usage.

License

GNU AGPL 3.0