Skip to content

README examples that don't type-check (Redis options, elicitation, security subpath) #265

Closed

Description

@mcollina

Four README examples don't compile against the package's types (checked by extracting them and running tsc --noEmit in strict mode):

  1. Redis setup passes retryDelayOnFailover; the redis option type (src/types.ts) only allows host, port, password, db (and tls on newer code). The README (and CLAUDE.md) say "additional ioredis connection options supported", which is true at runtime only.
  2. URL elicitation calls mcpNotifyElicitationComplete(sessionId, elicitationId) with sessionId: string | null.
  3. Elicitation with a custom request id uses skills: { type: 'array', items: { type: 'string' } }, which is neither a valid elicitation schema nor assignable to the multi-select enum type.
  4. Rate limiting imports RateLimiter from @platformatic/mcp/security; package.json has no exports map, so the subpath does not exist.

Suggested fix

Widen the redis type to ioredis' RedisOptions (or drop the claim), and fix the three examples.

Found during the round-7 review of #170; also on main.

🤖 Generated with Claude Code

Activity

  1. added a commit that references this issue on Oct 14, 2026
    be61a04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions