Skip to content

Commit ee4f06f

Browse files
committed
fix: clarify description fields to specify plain text only
1 parent f022f1a commit ee4f06f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/protocols_io_mcp/tools/protocol.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class Material(BaseModel):
2424
unit: Annotated[str, Field(description="Unit of measurement for the material, e.g., 'mL', 'g', 'μL'")]
2525

2626
class ProtocolStepInput(BaseModel):
27-
description: Annotated[str, Field(description="Description of the step")]
27+
description: Annotated[str, Field(description="Description of the step (plain text only)")]
2828
materials: Annotated[list[Material], Field(description="Materials required for this step. Empty if no materials are needed")] = Field(default_factory=list)
2929
reference_protocol_ids: Annotated[list[int], Field(description="Protocol IDs referenced by this step. Empty if no references exist. Strongly recommend using at least one reference to ensure credibility")] = Field(default_factory=list)
3030

@@ -215,8 +215,8 @@ async def get_protocol_steps(
215215

216216
@mcp.tool()
217217
async def create_protocol(
218-
title: Annotated[str, Field(description="Title of the new protocol")],
219-
description: Annotated[str, Field(description="Description of the new protocol")],
218+
title: Annotated[str, Field(description="Title of the new protocol (plain text only)")],
219+
description: Annotated[str, Field(description="Description of the new protocol (plain text only)")],
220220
) -> Protocol | ErrorMessage:
221221
"""
222222
Create a new protocol with the given title and description.
@@ -240,7 +240,7 @@ async def create_protocol(
240240
@mcp.tool()
241241
async def update_protocol_title(
242242
protocol_id: Annotated[int, Field(description="Unique identifier for the protocol")],
243-
title: Annotated[str, Field(description="New title for the protocol")]
243+
title: Annotated[str, Field(description="New title for the protocol (plain text only)")]
244244
) -> Protocol | ErrorMessage:
245245
"""
246246
Update the title of an existing protocol by its protocol ID.
@@ -258,7 +258,7 @@ async def update_protocol_title(
258258
@mcp.tool()
259259
async def update_protocol_description(
260260
protocol_id: Annotated[int, Field(description="Unique identifier for the protocol")],
261-
description: Annotated[str, Field(description="New description for the protocol")]
261+
description: Annotated[str, Field(description="New description for the protocol (plain text only)")]
262262
) -> Protocol | ErrorMessage:
263263
"""
264264
Update the description of an existing protocol by its protocol ID.

0 commit comments

Comments
 (0)