Commit 051489c
docs: add missing actor.json properties (meta, title, webServerMcpPath) (#2218)
Fixes #1813
Fixes #1941
## Changes
Added documentation for three properties that were missing from the
actor.json reference:
### 1. `title` property
- **Description**: Display title for the Actor in Apify Console and
Store
- **Type**: Optional
- **Usage**: Human-readable title; falls back to `name` if not specified
### 2. `meta` property
- **Description**: Metadata object containing additional Actor
information
- **Type**: Optional
- **Current fields**: `templateId` (identifies the template from which
the Actor was created)
### 3. `webServerMcpPath` property
- **Description**: HTTP endpoint path for MCP (Model Context Protocol)
server functionality
- **Type**: Optional
- **Usage**: When set, the Actor is recognized as an MCP server
- **Reference**: [Build and Deploy MCP Servers blog
post](https://blog.apify.com/build-and-deploy-mcp-servers-typescript/)
## What was missing
These properties are already used by:
- Apify platform (for Actor metadata and MCP servers)
- Actor templates (which include `meta.templateId` in generated
`.actor/actor.json` files)
However, they were not documented in the actor.json reference page.
## Updates
- Added all three properties to the reference table
- Updated the full example to show usage of these properties
- Maintained consistency with existing documentation style
## Testing
- [x] All properties documented with clear descriptions
- [x] Example JSON updated to show realistic usage
- [x] Links added where relevant (Standby mode for webServerMcpPath)
---
🤖 Generated with Claude Code
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **Low Risk**
> Documentation-only update that adds reference entries and an example
for existing `actor.json` fields; no runtime or API behavior changes.
>
> **Overview**
> Updates the `actor.json` docs to include three previously undocumented
properties: **`title`** (human-readable display name),
**`meta.templateId`** (template provenance metadata), and
**`webServerMcpPath`** (marks an Actor web server endpoint as an MCP
interface).
>
> The full `actor.json` example is expanded to show these fields, and
the reference table is updated with descriptions for each new property.
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
268a348. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>1 parent 6262792 commit 051489c
1 file changed
Lines changed: 9 additions & 1 deletion
Lines changed: 9 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| 26 | + | |
26 | 27 | | |
27 | 28 | | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
28 | 32 | | |
29 | 33 | | |
30 | 34 | | |
| |||
39 | 43 | | |
40 | 44 | | |
41 | 45 | | |
42 | | - | |
| 46 | + | |
| 47 | + | |
43 | 48 | | |
44 | 49 | | |
45 | 50 | | |
| |||
69 | 74 | | |
70 | 75 | | |
71 | 76 | | |
| 77 | + | |
72 | 78 | | |
73 | 79 | | |
| 80 | + | |
74 | 81 | | |
75 | 82 | | |
76 | 83 | | |
| |||
83 | 90 | | |
84 | 91 | | |
85 | 92 | | |
| 93 | + | |
0 commit comments