Skip to content

Skills: add common mistakes sections for entities and agents#54

Merged
netanelgilad merged 1 commit intomainfrom
docs/prevent-common-schema-and-agent-mistakes
Jan 30, 2026
Merged

Skills: add common mistakes sections for entities and agents#54
netanelgilad merged 1 commit intomainfrom
docs/prevent-common-schema-and-agent-mistakes

Conversation

@tuvit
Copy link
Contributor

@tuvit tuvit commented Jan 30, 2026

Summary

  • Add explicit warnings about common configuration mistakes in entity and agent docs
  • Fix incorrect lowercase entity name example in agents-push.md (tasksTask)
  • Add best practices for agent instructions when using entity tools

Problem

The existing documentation showed correct examples but didn't warn about common incorrect patterns. This led to debugging issues:

  1. Entity schema: Developers used nested "schema": { "type": "object" } structure (common in other platforms) instead of top-level "type": "object"
  2. Agent tool_configs: Used "tools" with "type": "entity_query" format (resembles OpenAI's function calling) instead of "tool_configs" with "entity_name"
  3. Entity name casing: Original docs example used lowercase "tasks" but entities require PascalCase "Task"
  4. Agent instructions: No guidance on explicitly instructing agents to use entity tools

Changes

entities-create.md

  • Added "Common Mistake: Nested Schema Property" section with wrong/correct examples

agents-push.md

  • Fixed entity_name example from "tasks" to "Task" (PascalCase)
  • Added agent file naming convention (underscores required, not hyphens)
  • Added "Common Mistake: Wrong tool_configs Format" section
  • Added "Best Practices for Agent Instructions" section

Test plan

  • Review the documentation changes for accuracy
  • Verify examples match current Base44 CLI behavior

🤖 Generated with Claude Code

Add documentation to prevent common configuration errors:

- entities-create.md: Add warning about nested "schema" property mistake
  that causes "Invalid schema: Schema must have a 'type' field" errors

- agents-push.md:
  - Fix entity_name example to use PascalCase (Task not tasks)
  - Add agent file naming convention (underscores, not hyphens)
  - Add warning about wrong "tools" vs "tool_configs" format
  - Add best practices for agent instructions when using entity tools

These issues were discovered during real-world usage and caused
significant debugging time.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@claude
Copy link
Contributor

claude bot commented Jan 30, 2026


Code review

No issues found. Checked for bugs and CLAUDE.md compliance.


@tuvit tuvit changed the title docs: add common mistakes sections for entities and agents Skills: add common mistakes sections for entities and agents Jan 30, 2026
@netanelgilad netanelgilad merged commit c716209 into main Jan 30, 2026
1 check passed
@netanelgilad netanelgilad deleted the docs/prevent-common-schema-and-agent-mistakes branch January 30, 2026 16:23
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.

2 participants