Get Series
series_getRead a Series identity, creative defaults and revision.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| seriesId | Yes | ||
| workspaceId | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| series | Yes |
series_getRead a Series identity, creative defaults and revision.
| Name | Required | Description | Default |
|---|---|---|---|
| seriesId | Yes | ||
| workspaceId | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| series | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description's 'Read' aligns with the readOnlyHint annotationating and there is no contradiction. It adds some transparency by listing what is read (identity, creative defaults, revision), but it does not explain side effects or lack thereof beyond what the readOnlyHint already signals.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single short sentence that leads with the operation ('Read') and lists the resource aspects. It is efficient and free of padding, though the phrasing 'a Series identity' is slightly awkward and could be more polished.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description leaves out important context: what the revision is, how it is selected, and what the workspace/series relationship is. While annotations cover safety, the description is too terse to fully prepare an agent to make correct use of this tool among many series-related siblings.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema provides no description for either parameter, so an agent must infer that `seriesId` identifies the resource and `workspaceId` scopes the read only from their names. The description fails to clarify how the parameters relate to the returned identity, creative defaults, or revision.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly uses the verb 'Read' and names the resource (a Series) plus the data facets: identity, creative defaults, and revision. It is specific enough for an agent to understand this is a read operation, though it does not explicitly contrast with sibling tools like series_content or series_apply.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus the many related series_* and get_* siblingsamental. It does not mention which series fields are included, whether the revision is current or historical, or any preconditions such as needing a project or workspace context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.