Payram

Test PayRam connectivity (deprecated)

test_payram_connection

Read-onlyIdempotent

Deprecated: use payram_doctor, which does this and more. Read-only check that a PayRam server is reachable and healthy and, if an API key is supplied, that the key is accepted. Never creates payments.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`apiKey`	No	Optional project API key to validate (nothing is created). Passing it exposes the key in this conversation.
`baseUrl`	No	PayRam URL, same origin as the dashboard (e.g. https://pay.example.com). Defaults to PAYRAM_BASE_URL in local mode.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`ok`	Yes
`baseUrl`	Yes
`keyChecked`	Yes
`errorMessage`	No
`payramVersion`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed9 schema fields changedOct 8, 2026

changedInput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

removedInput schema / additionalProperties
```
Removed value: -false
```

changedInput schema / properties / apiKey / description

Previous value: -"Your Payram API key from the dashboard. If not provided, uses PAYRAM_API_KEY from environment."New value: +"Optional project API key to validate (nothing is created). Passing it exposes the key in this conversation."

changedInput schema / properties / baseUrl / description

Previous value: -"The base URL of your Payram server (e.g., https://your-server.example). If not provided, uses PAYRAM_BASE_URL from environment."New value: +"PayRam URL, same origin as the dashboard (e.g. https://pay.example.com). Defaults to PAYRAM_BASE_URL in local mode."

removedInput schema / properties / baseUrl / format
```
Removed value: -"uri"
```

changedOutput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

addedOutput schema / properties / keyChecked
```
Added value: +{
+  "type": "boolean"
+}
```

removedOutput schema / properties / statusCode

Removed value: -{
-  "anyOf": [
-    {
-      "maximum": 599,
-      "minimum": 100,
-      "type": "integer"
-    },
-    {
-      "type": "null"
-    }
-  ]
-}

changedOutput schema / required

Previous value: -[
-  "ok",
-  "statusCode",
-  "baseUrl"
-]New value: +[
+  "ok",
+  "baseUrl",
+  "keyChecked"
+]

First observedFeb 18, 2026

TDQS

A4.3/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover readOnly/idempotent/destructive/openWorld. The description adds value beyond that: it discloses the apiKey validation behavior, the 'never creates payments' guarantee, and the deprecation supersession. It does not mention rate limits or output shape, but output schema exists so return values needn't be explained.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, front-loaded with deprecation and replacement, then behavior, then safety guarantee. Every sentence earns its place with zero filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a deprecated read-only connectivity test with output schema present and full schema coverage, the description is complete: it signals deprecation, redirects to the successor, describes the check scope, and states the non-mutating guarantee.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and both parameters are well documented in-schema (apiKey exposure warning, baseUrl default). The description adds a summary of apiKey's purpose but no new syntax or format detail beyond the schema. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a clear verb+resource ('Read-only check that a PayRam server is reachable and healthy') and its deprecation status, explicitly naming payram_doctor as the replacement. Distinct from sibling tools which generate snippets/docs. Docked one point because the deprecated status makes the tool's role somewhat muddied.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names the superseding tool ('use payram_doctor, which does this and more') and states exactly when the apiKey validation path applies. The 'Never creates payments' line clarifies the boundary. This is a textbook when-to-use vs alternative statement.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Payram tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?