`list_states`

Pack: ibge-br · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/list_states for the schema, then POST the same URL with its arguments for the data.

List all 27 Brazilian states (UFs) with id, 2-letter sigla, name, and region (e.g. “SP” → São Paulo, Sudeste). Useful for resolving state names/codes before querying municipalities or regional data.

Parameters

Name	Type	Required	Description
`orderBy`	string	no	Sort field: “nome” or “id” (default “nome”).

Example call

Arguments

{
  "orderBy": "nome"
}

curl

curl -X POST https://gateway.pipeworx.io/ibge-br/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"list_states","arguments":{"orderBy":"nome"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('list_states', {
  "orderBy": "nome"
});

More examples

{
  "orderBy": "id"
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

{
  "mcpServers": {
    "pipeworx": {
      "url": "https://pipeworx.io/mcp"
    }
  }
}

Connect to just the ibge-br pack

{
  "mcpServers": {
    "ibge-br": {
      "url": "https://gateway.pipeworx.io/ibge-br/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

list_states