get_orgs_types

Read-only

Calls GET /api/orgs/types as the signed-in person · REST reference

List the organization types the platform recognises

Static enumeration compiled in from src/types/OrganizationType.ts, one entry per value with a display name and a description. Unauthenticated and reads nothing — there is no database access on this path. WATCH THE VOCABULARY: the value strings published here are Title_Case (Network, Service_Provider). That is what POST /api/orgs expects and what Neo4j stores. The DAL's own OrgType enum spells the same set SCREAMING_SNAKE and is reference-only — the wire field is a plain String validated case-insensitively — so a caller comparing an org's type against these values must fold case.

Arguments

This tool takes no arguments.

Example call

A client sends this over the MCP session; Claude and other agents build it for you. The values are placeholders — the shape is real.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_orgs_types",
    "arguments": {}
  }
}

Result

On success (HTTP 200) the tool returns one text item holding the API's JSON, pretty-printed.

The full type list. Neither a bare array nor a success envelope.

json
{
  "count": 1,
  "types": [
    {
      "description": "string",
      "label": "string",
      "value": "Network"
    }
  ]
}

Fields

FieldTypeDescription
countintegerLength of types.
typesarray of object
types[].descriptionstring
types[].labelstringHuman-readable display name.
types[].value"Network" | "Partner" | "Distributor" | "Service_Provider" | "Donor"

When it fails

A failed call returns isError: true with the API's message as text.

What the model is shown

This is the tool exactly as the server lists it in tools/list. The description starts with the REST call it makes.

json
{
  "name": "get_orgs_types",
  "description": "GET /api/orgs/types — Static enumeration compiled in from `src/types/OrganizationType.ts`, one entry per value with a display name and a description. Unauthenticated and reads nothing — there is no database access on this path. WATCH THE VOCABULARY: the `value` strings published here are Title_Case (`Network`, `Service_Provider`). That is what `POST /api/orgs` expects and what Neo4j stores. The DAL's own `OrgType` enum spells the same set SCREAMING_SNAKE and is reference-only — the wire field is a plain String validated case-insensitively — so a caller comparing an org's `type` against these values must fold case.",
  "inputSchema": {
    "type": "object",
    "properties": {}
  },
  "annotations": {
    "readOnlyHint": true,
    "openWorldHint": false
  }
}