Available Tools
Available Tools
The Groove MCP server exposes 9 tools. All of them are read-only — they answer from the embedded documentation snapshot and never call a backend or change any state.
| Tool | Purpose |
|---|---|
list_tools |
List every available tool with its description and input schema. |
get_server_info |
Report the server name, version and endpoint count. |
list_endpoints |
List every documented endpoint, grouped by category. |
get_endpoint |
Return the full specification of one endpoint. |
search_docs |
Search endpoints by name, summary or category. |
sign_request |
Compute the X-Groove-Signature for a request. |
verify_signature |
Check whether a signature is valid for a request. |
generate_snippet |
Return a runnable code example for one endpoint. |
generate_integration |
Generate the files of a ready-to-run integration project. |
Every tool is called with method: "tools/call" — see Setup for the request format.
integration argumentSeveral tools take an integration argument. For the integration documented on this site, always pass "regular".
Discovery
list_tools
List all available MCP tools with their descriptions and input schemas.
Arguments: none.
Returns: total_tools and a tools array, each entry with name, description and input_schema.
get_server_info
Report this MCP server’s name, version, and how many endpoints it serves. Useful as a connectivity check.
Arguments: none.
Returns: the server identity — groove-mcp, its version, and the number of endpoints loaded.
Documentation lookup
list_endpoints
List every documented endpoint, grouped by category.
| Argument | Required | Values | Description |
|---|---|---|---|
integration |
No | regular |
Restrict the listing to this integration. |
Returns: a grouped listing — endpoint name, HTTP method and one-line summary per category.
37 endpoint(s):
[regular] Transaction API
- GetAccount (GET) — Validate the player session and return account details.
- GetBalance (GET) — Return the player's current balance.
...get_endpoint
Return the full spec — parameters, responses, error codes, signature and authentication — for one endpoint.
| Argument | Required | Values | Description |
|---|---|---|---|
integration |
Yes | regular |
The integration documented on this site. |
name |
Yes | e.g. Wager, GetBalance |
Endpoint name. |
Returns: the endpoint object, including name, category, summary, method, path, auth, params, responses, errorCodes, signature, and the sourceUrl of the documentation page it was taken from.
Example call:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_endpoint",
"arguments": { "integration": "regular", "name": "Wager" }
}
}search_docs
Search endpoints by name, summary or category.
| Argument | Required | Values | Description |
|---|---|---|---|
query |
Yes | free text | e.g. balance, free spin, rollback. |
integration |
No | regular |
Restrict the search to this integration. |
Returns: a match list of [integration / category] Name — Summary.
Signatures
sign_request
Compute the X-Groove-Signature for a request — HMAC-SHA256 over the sorted parameter values, hex-encoded.
| Argument | Required | Description |
|---|---|---|
integration |
Yes | regular. |
query |
Yes | The raw query string — everything after the ?. |
key |
Yes | Your Groove security key. |
Returns: the ready-to-use header line.
Example call:
{
"name": "sign_request",
"arguments": {
"integration": "regular",
"query": "request=getaccount&gamesessionid=123_jdhdujdk&accountid=111&device=desktop&apiversion=1.2",
"key": "test_key"
}
}Result:
X-Groove-Signature: be426d042cd71743970779cd6ee7881d71d1f0eb769cbe14a0081c29c8ef2a09verify_signature
Check whether a signature is valid for a request — the same check Groove performs. Use it to debug a rejected request.
| Argument | Required | Description |
|---|---|---|
integration |
Yes | regular. |
query |
Yes | The raw query string. |
key |
Yes | Your Groove security key. |
signature |
Yes | The hex signature to check. |
Returns: valid, or the failure the caller would have seen — invalid signature (code 1001).
See Signature Validation for how the signature is built.
Code generation
generate_snippet
Return a runnable code example for one endpoint, with the signing or verification step shown explicitly rather than hidden in a helper.
| Argument | Required | Values | Description |
|---|---|---|---|
integration |
Yes | regular |
The integration documented on this site. |
name |
Yes | e.g. Wager |
Endpoint name. |
language |
Yes | go | java | python | typescript | curl |
Output language. |
signed |
No | true (default) | false |
Include the X-Groove-Signature step for Transaction API calls. Set to false if your account does not use signature validation. |
Returns: the snippet as text.
generate_integration
Generate a ready-to-run integration blueprint: the files of a startable project — a real /groove entry point, the documented success responses and error catalogue, and one wallet seam per operation family for you to fill in, routed per brand.
It emits the full core transaction flow; individual endpoints cannot be selected.
| Argument | Required | Values | Description |
|---|---|---|---|
integration |
Yes | regular |
The integration documented on this site. |
language |
Yes | go | java | python | typescript |
Target language. |
Returns: a JSON project — integration, language, optional notes, and a files array:
{
"integration": "regular",
"language": "go",
"files": [
{ "path": "go.mod", "action": "overwrite", "content": "..." },
{ "path": "main.go", "action": "overwrite", "content": "..." },
{ "path": "app/wallet.go", "action": "create-if-absent", "content": "..." }
]
}The action tells you how to write each file:
| Action | Meaning |
|---|---|
overwrite |
Regenerated on every call — safe to replace, do not edit by hand. |
create-if-absent |
Your wallet seam. Written once and never clobbered, so your edits survive regeneration. |