Set Parameter: McpServer.json
Precautions¶
When you change parameters, check Confirmation When Changing Parameters.
Setting Values¶
The settings of this parameter file are as follows.
Top-level object¶
| Parameter | Configuration Example | Description |
|---|---|---|
| Enabled | false | Switches the MCP server between enabled and disabled. |
| ReadOnlyMode | false | When true, only the read tools can be used. For details, refer to Read-only mode. |
| LogExportLimit | 10000 | Sets the upper limit on the number of MCP logs when exporting them to CSV. |
| RateLimit | - | The settings object for the rate limit. For details, refer to Rate limit settings. |
| Logging | - | The settings object for the log output. For details, refer to MCP log settings. |
Read-only mode (ReadOnlyMode)¶
When ReadOnlyMode is true, it becomes read-only mode and only the following read tools can be used. The other write tools are blocked with a rejection message.
List of read tools¶
| Category | Tool Name | Function |
|---|---|---|
| Record operations | GetItems | Gets the list of records in a site |
| GetItem | Gets the details of a single record | |
| CreateUpdateItemJson | Generates JSON for updating (converts Japanese to codes) | |
| Getting site information | GetSiteIdByTitle | Searches for a site ID by site name |
| GetSite | Gets the setting information of a site | |
| Getting user information | GetUserIdByName | Searches for a user ID by user name |
| GetUsers | Gets the list of users | |
| View operations | CreateViewJson | Creates the View JSON of search conditions |
| GetView | Gets the view settings | |
| GetViewIdByViewName | Searches for a view ID by view name |
Rate limit settings (RateLimit)¶
A rate limit is a mechanism that restricts the number of operations that can be carried out within a given period of time. Pleasanter MCP offers four kinds of rate limit method.
- When you enable several rate limit methods at the same time, all the limiters are applied in a chain. Rate limits are partitioned per API key.
- When a rate limit is exceeded, HTTP 429 is returned and a Retry-After header is added. The response body contains a message in JSON-RPC error format.
- The check of the usage limit is done at the moment the user sends a request. The system that received the request calculates the time of the next reset and judges whether the current usage is within the limit. This check is not run periodically in the background; it is judged on the spot for each request.
(1) FixedWindow¶
A method that resets the counter every fixed period (window) and limits the number of operations within that window. If operations are concentrated around the boundary of a window, in the worst case it allows throughput of almost twice the rate limit.
| Parameter | Configuration Example | Description |
|---|---|---|
| Enabled | false | Switches the fixed window method between enabled and disabled. |
| PermitLimit | 30 | Sets the number of requests permitted within a window. |
| WindowSeconds | 60 | Sets the length of the window (seconds). |
(2) SlidingWindow¶
A method that limits the number of operations targeting only the most recent fixed period (window). Pleasanter MCP uses the counter approximation method, which divides the window into several segments and limits the number of operations per segment. In general, bursts at the window boundary are said to be less likely than with Fixed Window.
If you increase SegmentsPerWindow, the time resolution becomes finer and the memory consumption and the update frequency increase. If you decrease SegmentsPerWindow, it gets closer to the FixedWindow method.
| Parameter | Configuration Example | Description |
|---|---|---|
| Enabled | false | Switches the sliding window method between enabled and disabled. |
| PermitLimit | 30 | Sets the number of requests permitted within a window. |
| WindowSeconds | 60 | Sets the length of the window (seconds). |
| SegmentsPerWindow | 5 | Sets the number of segments the window is divided into. |
(3) TokenBucket¶
A method that limits the number of operations by consuming tokens in a bucket. As long as there are tokens in the bucket the processing is permitted immediately, and when they run out it is rejected. The tokens in the bucket are replenished at fixed intervals. It suits cases where you want a limit per unit of time while still coping with momentary increases in throughput.
| Parameter | Configuration Example | Description |
|---|---|---|
| Enabled | false | Switches the token bucket method between enabled and disabled. |
| TokenLimit | 10 | Sets the maximum number of tokens in the bucket. |
| TokensPerPeriod | 1 | Sets the number of tokens added per replenishment period. |
| ReplenishmentPeriodSeconds | 2 | Sets the token replenishment interval (seconds). |
(4) Concurrency¶
A method closer to load control. It limits the number of concurrent executions rather than the number of times per unit of time. The count is increased when a concurrent execution starts and decreased when it completes.
| Parameter | Configuration Example | Description |
|---|---|---|
| Enabled | false | Switches the concurrency limit method between enabled and disabled. |
| PermitLimit | 3 | Sets the maximum number of concurrent requests. |
MCP log settings (Logging)¶
These are the settings for the logs of MCP requests and responses.
| Parameter | Configuration Example | Description |
|---|---|---|
| EnableLoggingToDatabase | true | Sets whether to record MCP logs in the database. Refer to MCP Log Management Function. |
| EnableLoggingToFile | false | Sets whether to record MCP logs in a file. How to configure it is the same as for Enables System Log Output As Text. |
| NotLoggingIp | [127.0.0.1] | Sets the list of IP addresses for which MCP logs are not recorded (CIDR notation is supported). |
| ResponseDataMaxLength | 65536 | Sets the maximum size (bytes) of the response data to store. 0 means unlimited. Anything over the limit is truncated. |
Supported Versions¶
| Supported Version | Description |
|---|---|
| 1.5.2.0 and later | McpServer.json added |