Skip to content

Write a tutorial: "How to Create a Custom Agent Tool" #1

Description

@kanweiwei

CreatorWeave has 30+ agent tools, but there's no tutorial showing how to add a new one.

What to do:

  1. Study an existing simple tool like web/agent/tools/ls.tool.ts
  2. Study the tool registration in web/agent/tools/ and the ToolEntry type in tool-types.ts
  3. Write a step-by-step tutorial at docs/tutorials/custom-agent-tool.md covering:
    • How tool definitions work (OpenAI function calling format)
    • How to implement a ToolExecutor
    • How to register a tool
    • A complete example (e.g., a "word count" tool)

Skills needed: TypeScript, ability to read and understand existing code patterns

Reference files:

  • web/agent/tools/ls.tool.ts — simple tool example
  • web/agent/tools/tool-types.ts — type definitions
  • web/agent/tools/switch-mode.tool.ts — another simple tool

Estimated time: 3-4 hours

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions