96385fde3cAudioContent should have had a non-pointer receiver, to be consistent with other content types. Add this to our log of rough edges to reconsider for v2. Fixes #641
27 lines
1.2 KiB
Markdown
27 lines
1.2 KiB
Markdown
# Rough edges: API decisions to reconsider for v2
|
|
|
|
This file collects a list of API oversights or rough edges that we've uncovered
|
|
post v1.0.0, along with their current workarounds. These issues can't be
|
|
addressed without breaking backward compatibility, but we'll revisit them for
|
|
v2.
|
|
|
|
- `EventStore.Open` is unnecessary. This was an artifact of an earlier version
|
|
of the SDK where event persistence and delivery were combined.
|
|
|
|
**Workaround**: `Open` may be implemented as a no-op.
|
|
|
|
- Enforcing valid tool names: with
|
|
[SEP-986](https://github.com/modelcontextprotocol/modelcontextprotocol/issues/986)
|
|
landing after the SDK was at v1, we missed an opportunity to panic on invalid
|
|
tool names. Instead, we have to simply produce an error log. In v2, we should
|
|
panic.
|
|
|
|
- Inconsistent naming.
|
|
- `ResourceUpdatedNotificationsParams` should probably have just been
|
|
`ResourceUpdatedParams`, as we don't include the word 'notification' in
|
|
other notification param types.
|
|
- Similarly, `ProgressNotificationParams` should probably have been
|
|
`ProgressParams`.
|
|
|
|
- `AudioContent.MarshalJSON` should have had a pointer receiver, to be
|
|
consistent with other content types.
|