Skip to content

Commit 3f27a38

Browse files
authored
docs: document input schema processing (#58)
document Actor input schema processing in README
1 parent 0e5ba2e commit 3f27a38

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -365,8 +365,13 @@ Upon launching, the Inspector will display a URL that you can access in your bro
365365

366366
## ⓘ Limitations and feedback
367367

368-
To limit the context size the properties in the `input schema` are pruned and description is truncated to 500 characters.
369-
Enum fields and titles are truncated to max 50 options.
368+
The Actor input schema is processed to be compatible with most MCP clients while adhering to [JSON Schema](https://json-schema.org/) standards. The processing includes:
369+
- **Descriptions** are truncated to 500 characters (as defined in `MAX_DESCRIPTION_LENGTH`).
370+
- **Enum fields** are truncated to a maximum combined length of 200 characters for all elements (as defined in `ACTOR_ENUM_MAX_LENGTH`).
371+
- **Required fields** are explicitly marked with a "REQUIRED" prefix in their descriptions for compatibility with frameworks that may not handle JSON schema properly.
372+
- **Nested properties** are built for special cases like proxy configuration and request list sources to ensure correct input structure.
373+
- **Array item types** are inferred when not explicitly defined in the schema, using a priority order: explicit type in items > prefill type > default value type > editor type.
374+
- **Enum values and examples** are added to property descriptions to ensure visibility even if the client doesn't fully support JSON schema.
370375
371376
Memory for each Actor is limited to 4GB.
372377
Free users have an 8GB limit, 128MB needs to be allocated for running `Actors-MCP-Server`.

0 commit comments

Comments
 (0)