Skip to content

Commit 1d5291e

Browse files
committed
docs: clarify tool description field requirements and client compatibility
1 parent 8e7b202 commit 1d5291e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/CUSTOM_TOOLS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,9 @@ def my_custom_tool(
5959
)
6060
```
6161

62-
You can use all options available in FastMCP's `mcp.tool` function decorator: <https://gofastmcp.com/servers/tools#tools>. The `description` is the only required field.
62+
You can use all options available in FastMCP's `mcp.tool` function decorator: <https://gofastmcp.com/servers/tools#tools>.
63+
64+
**Note:** All tools should have the `description` field. It's not strictly required, however, that parameter is the best place to define a description so that most MCP clients can read it. See [issue #289](https://github.com/CoplayDev/unity-mcp/issues/289).
6365

6466
### Auto-Discovery
6567

0 commit comments

Comments
 (0)