json-rpc-server

03 — Parameters & DTOs

Three ways to receive parameters, picked by handler signature:

Pattern Signature When to use
DTO __invoke(MyRequest $req) Anything with more than one field, especially anything you want validated.
#[Rpc\Param] __invoke(#[Rpc\Param] int $userId) One-or-two scalar inputs, or when a DTO feels heavy.
RpcRequest __invoke(RpcRequest $req) Schemas that vary at runtime, or proxies that forward verbatim.

All three can be mixed with injected parameters (Context, Request).

Flat params in the JSON request

Regardless of how many PHP parameters your handler declares, clients always send one JSON object inside the HTTP body — under the params key of the JSON-RPC request (never a nested bag named after the DTO parameter):

{
  "params": {
    "email": "x@y",
    "limit": 25,
    "user_id": 42
  }
}

The bundle maps keys to handler arguments like this:

Handler shape What appears in params MCP / OpenRPC inputSchema
Single DTO Keys = DTO constructor property names Same flat keys
DTO + scalar(s) DTO fields and scalar keys side by side Same flat keys
Scalars only (#[Rpc\Param] or auto-promoted) One key per business parameter Same flat keys
Multiple DTOs Union of every DTO’s ctor keys (flat) Same flat keys — allowed; any duplicate JSON key fails container build
RpcRequest only Whatever you read manually Empty / no automatic schema

Examples:

// Single DTO — params: {"email": "...", "limit": 25}
public function __invoke(GetUserRequest $req, Context $ctx): array

// DTO + scalar sibling — params: {"street": "...", "city": "...", "autoId": 7}
public function __invoke(AddressDto $address, #[Assert\Positive] int $autoId, Context $ctx): array

// Scalars only — params: {"user_id": 42, "reason": null}
public function __invoke(#[Rpc\Param('user_id')] int $userId, ?string $reason, Context $ctx): array

// Two DTOs — params: {"street": "...", "city": "...", "email": "..."}
// (AddressDto + ContactDto as long as ctor field names do not overlap)
public function __invoke(AddressDto $address, ContactDto $contact, Context $ctx): array

Auto-promotion: a bare builtin / mixed parameter (not Context, not Request, not RpcRequest, not a class DTO) is treated as #[Rpc\Param] with name = the PHP parameter name, so it still shows up in MCP/OpenRPC without the attribute.

Key ownership is enforced at container compile time — every JSON key in params must belong to exactly one business parameter. Collisions fail the build (DTO field city + another DTO’s city, or DTO id + scalar $id). There is no limit on how many DTOs you declare; only duplicate keys are forbidden.

Pattern 1 — DTO

final readonly class GetUserRequest
{
    public function __construct(
        #[Assert\Email]
        public string $email,
        #[Assert\Range(min: 1, max: 100)]
        public int $limit = 25,
    ) {}
}

#[Rpc\Method('user.get')]
final class GetUser
{
    public function __invoke(GetUserRequest $req, Context $ctx): array
    {
        // $req is fully validated; $req->email is guaranteed non-empty
        // and shaped like an email.
    }
}

The dispatcher:

  1. Denormalizes the JSON object into the DTO via Symfony’s DenormalizerInterface.
  2. Validates the resulting instance via Symfony’s Validator component.
  3. Throws InvalidParamsException (-32602) on either failure, with a list of per-field violations in error.data.

Rejecting unknown fields

By default unknown keys produce an Invalid params error:

{"params": {"email": "x@y", "limit": 25, "deprecatedField": 1}}

{
  "error": {
    "code": -32602,
    "message": "Unknown parameter(s): deprecatedField. Set ...",
    "data": [{"path": "deprecatedField", "message": "Unknown parameter", "code": null}]
  }
}

Catches client typos. Turn it off per-method when you need backward-compat:

#[Rpc\Method('user.legacy_get', rejectUnknown: false)]

Or globally:

json_rpc_server:
  params:
    reject_unknown: false

Positional params for a single-DTO method

By default a method that takes one DTO requires named params ({...}). Positional ([...]) is rejected because it locks the DTO constructor argument order into your public API.

To opt in:

#[Rpc\Method('user.get', allowPositionalDto: true)]

Or globally:

json_rpc_server:
  params:
    allow_positional_dto: true

When enabled, "params": ["x@y", 25] maps positionally onto the DTO’s constructor arguments.

Nested DTO property vs array of DTOs

A DTO field can be another DTO or a list of DTOs:

final readonly class TeamRequest
{
    /**
     * @param list<MemberDto> $members
     */
    public function __construct(
        #[Assert\Valid]
        public array $members,
    ) {}
}

What the client sends in params:

{"params": {"members": [{"name": "alice"}, {"name": "bob"}]}}

Associative maps (array<string, T>)

In PHP you type the field as array, but the client sends a JSON object { "key": value, … } — not a JSON array […]. Typical examples: filters, tags, metadata maps.

Document the promoted property or constructor parameter:

final readonly class ListRequest
{
    public function __construct(
        /** @var array<string, FilterSpec> */
        public array $filters = [],
    ) {}
}

Example request (params excerpt):

{"params": {"filters": {"groupId": {"mode": "include", "value": [1]}}}}

Generated OpenRPC / MCP schema (uses type: object, not type: array + items):

"filters": {
  "type": "object",
  "additionalProperties": {
    "type": "object",
    "properties": { "mode": { "type": "string" }, "value": { "type": "array" } }
  }
}

Put @var on the property (promoted ctor param) or a matching @param on the constructor — class-level docblocks alone are not read. Union value types (array<string, A|B>) become additionalProperties.oneOf.

Pattern 2 — #[Rpc\Param]

For a method with one or two scalar inputs, a DTO feels heavy. Use #[Rpc\Param]:

#[Rpc\Method('user.findById')]
final class FindById
{
    public function __invoke(
        #[Rpc\Param('user_id')]                          // remap JSON key
        #[Assert\Positive]                                // standard validator
        int $userId,

        #[Rpc\Param('reason', required: false)]
        ?string $reason = null,

        Context $ctx,
    ): array {
        // $userId is validated (positive). $reason may be null.
    }
}

Effects:

required: is informational for the JSON Schema. Whether the param is actually mandatory is driven by the PHP signature: default value or nullable type makes it optional.

Pattern 3 — RpcRequest

For methods that need to inspect the raw envelope (custom routing, proxying, generic schemas):

#[Rpc\Method('legacy.proxy')]
final class LegacyProxy
{
    public function __invoke(RpcRequest $req): array
    {
        // $req->id, $req->method, $req->params, $req->isNotification
        $value = $req->params->requireString('targetMethod');
        // ...
    }
}

RpcParams accessors

$req->params is an RpcParams object — a typed accessor over the JSON-RPC params value. Modelled after Symfony’s InputBag:

Method Returns On missing key or null
getString($key, $default) string returns $default
getInt($key, $default) int returns $default
getFloat($key, $default) float returns $default
getBool($key, $default) bool returns $default
getArray($key, $default) array returns $default
requireString($key) string throws InvalidParamsException
requireInt($key) int throws InvalidParamsException
requireFloat($key) float throws InvalidParamsException
requireBool($key) bool throws InvalidParamsException
requireArray($key) array throws InvalidParamsException

All typed getters are strict: a present value of the wrong shape raises -32602, not silent coercion.

Positional access: $req->params->at(0), $req->params->isList(), $req->params->count().

Injected parameters

These are recognised by type and resolved by the dispatcher — they never come from the JSON envelope:

Type What it is
Knetesin\JsonRpcServerBundle\Context\Context Per-call context: methodName, requestId, user, roles. See Context.
Symfony\Component\HttpFoundation\Request The HTTP request. Resolved from RequestStack. Throws if there’s no active request (e.g. unit test out of context).
Knetesin\JsonRpcServerBundle\Request\RpcRequest The decoded JSON-RPC envelope.

You can mix and match — __invoke(MyDto $req, Context $ctx, Request $http) all work together.

Dates and date-times

The bundle ships Knetesin\JsonRpcServerBundle\Type\Date for “date without time” (because PHP doesn’t have one):

final readonly class CreateEventRequest
{
    public function __construct(
        public Date $startsOn,                  // date only
        public \DateTimeImmutable $startsAt,    // date+time
    ) {}
}

Input is lenient — the bundle accepts ISO, custom formats, “yesterday”, or unix timestamps depending on configuration:

json_rpc_server:
  serializer:
    datetime_format: 'iso8601'   # or 'timestamp' / 'timestamp_ms' / custom php date()
    date_format: 'Y-m-d'
    timezone: 'UTC'

For example, with datetime_format: timestamp_ms:

Full details in Configuration reference.

This site is open source. Improve this page.