Skip to content

Update quickstart.mdx - outdated example for tool call. #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 10, 2025
Merged

Update quickstart.mdx - outdated example for tool call. #192

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1079d1e
Update quickstart.mdx
TimonBerlin Jul 9, 2025
482a9ac
Update docs/src/content/docs/guides/quickstart.mdx
TimonBerlin Jul 10, 2025
9e75efa
Update quickstart.mdx
TimonBerlin Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/src/content/docs/guides/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,13 @@ const historyFunFact = tool({
name: 'history_fun_fact',
// The description is used to describe **when** to use the tool by telling it **what** it does.
description: 'Give a fun fact about a historical event',
// This agent takes no parameters, so we provide an empty JSON schema.
parameters: {
type: 'object',
properties: {},
required: [],
additionalProperties: false
}
Copy link
Member

@seratch seratch Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comma is missing:

Suggested change
}
},

Copy link
Member

@seratch seratch Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you have more time to tweak this, we prefer a slightly simpler one like:

import { Agent, run, tool } from '@openai/agents';
import { z } from 'zod';

const historyFunFact = tool({
  // The name of the tool will be used by the agent to tell what tool to use.
  name: 'history_fun_fact',
  // The description is used to describe **when** to use the tool by telling it **what** it does.
  description: 'Give a fun fact about a historical event',
  // This agent takes no parameters, so we provide an empty JSON schema.
  parameters: z.object({}),
  execute: async () => {
    // The output will be returned back to the Agent to use
    return 'Sharks are older than trees.';
  },
});

Copy link
Contributor Author

@TimonBerlin TimonBerlin Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @seratch, thanks for your response. I had already tried it as you suggested, using an empty Zod object, but I wasn’t able to get it running.

image

Copy link
Member

@seratch seratch Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably, it is due to #187, which is zod compat issue that we're going to apply workaround soon

Copy link
Contributor Author

@TimonBerlin TimonBerlin Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should i then go with the empty zod object or keep the json schema ?

Copy link
Member

@seratch seratch Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we consistently use zod as the primary option in the docs and examples, so please go ahead with an empty zod object here.

Copy link
Contributor Author

@TimonBerlin TimonBerlin Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seratch alright done ! Thank you very much :)

execute: async () => {
// The output will be returned back to the Agent to use
return 'Sharks are older than trees.';
Expand Down