Skip to content

docs(tarko): fix agent options in examples - #1602

Merged
ulivz merged 1 commit into
mainfrom
fix/examples-agent-options-mismatch
Sep 21, 2025
Merged

ulivz merged 1 commit into
mainfrom
fix/examples-agent-options-mismatch

Conversation

@ulivz

@ulivz ulivz commented Sep 21, 2025

Copy link
Copy Markdown
Member

Summary

Fixed incorrect AgentOptions property names in examples documentation to match actual source code interface.

Problem: The getting-started examples used deprecated property names:

  • systemPrompt instead of instructions
  • modelProvider instead of model
  • Included unnecessary description property

Solution: Updated all agent configurations in /examples/getting-started.mdx to use correct property names from multimodal/tarko/agent-interface/src/agent-options.ts.

Checklist

  • Added or updated necessary tests (Optional).
  • Updated documentation to align with changes (Optional).
  • Verified no breaking changes, or prepared solutions for any occurring breaking changes (Optional).
  • My change does not involve the above items.

@netlify

netlify Bot commented Sep 21, 2025 •

Copy link
Copy Markdown

✅ Deploy Preview for agent-tars-docs ready!

Name Link
🔨 Latest commit c8e3017
🔍 Latest deploy log https://app.netlify.com/projects/agent-tars-docs/deploys/68cf54d7c5fb4f0008efe692
😎 Deploy Preview https://deploy-preview-1602--agent-tars-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Sep 21, 2025 •

Copy link
Copy Markdown

✅ Deploy Preview for tarko ready!

Name Link
🔨 Latest commit c8e3017
🔍 Latest deploy log https://app.netlify.com/projects/tarko/deploys/68cf54d73eab260008ade1c8
😎 Deploy Preview https://deploy-preview-1602--tarko.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@ulivz

ulivz commented Sep 21, 2025

Copy link
Copy Markdown
Member Author

Hi! I just realized we've been working on the exact same issue! 😅

I also fixed the API usage problems in getting-started.mdx in my PR #1597, including:

  • createTool → Tool class
  • systemPrompt → instructions
  • modelProvider → model
  • Tool parameter fixes (JSON Schema → Zod, name → id, handler → function)
  • Method call fixes (query() → run())

It looks like we both spotted the same critical documentation issues. Should we coordinate to avoid duplicate work? I'm happy to close my changes and let your PR handle this since you created yours first.

What do you think would be the best approach?

@ulivz
ulivz merged commit 08701d8 into main Sep 21, 2025
10 checks passed
@ulivz
ulivz deleted the fix/examples-agent-options-mismatch branch September 21, 2025 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant