# Parma — how to use (mcp.ai)

Connect your Parma account and use 23 tools for CRM straight from your AI agent. Connect with your own API key. Parma CRM is a relationship management app designed to help you accelerate growth by deepening and nurturing your business relationships.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_parma?ms=1787293380000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `parma_add_relationship_to_group`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/parma`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/parma/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/parma/add/relationship/to/group` — Tool to add a relationship to a group in Parma. Use when you need to associate an existing relationship with a group.
  - body: { group_id: integer, relationship_id: string }
- `POST https://api.mcp.ai/api/parma/create/note` — Tool to create a new note in the Parma account. Use when you need to add a note linked to specific relationships.
  - body: { body: string, datetime?: string, relationship_ids: integer[] }
- `POST https://api.mcp.ai/api/parma/create/relationship` — Tool to create a new relationship in Parma. Use when you need to add a new person or company to your Parma account.
  - body: { name: string, type?: string, about?: string, group_ids: integer[], company_id?: integer }
- `POST https://api.mcp.ai/api/parma/data/json` — Tool to retrieve DCAT-US 1.1 compliant metadata of all datasets. Use when you need the complete catalog JSON (data.json) from Parma’s open data portal.
- `POST https://api.mcp.ai/api/parma/delete/relationship` — Tool to delete a relationship from Parma by its ID. Use when you need to remove an existing relationship between entities. Returns success confirmation after deletion (HTTP 204).
  - body: { id: string }
- `POST https://api.mcp.ai/api/parma/get/pipeline` — Tool to retrieve a pipeline by its ID. Use when you need to fetch details about a specific pipeline.
  - body: { id: string }
- `POST https://api.mcp.ai/api/parma/get/relationship` — Tool to retrieve a relationship by its unique ID. Use when you need to get detailed information about a specific relationship.
  - body: { id: string }
- `POST https://api.mcp.ai/api/parma/get/stage` — Tool to retrieve a stage by its unique identifier. Use when you need to fetch details about a specific stage in a pipeline.
  - body: { id: string }
- `POST https://api.mcp.ai/api/parma/get/user` — Tool to retrieve a user by their unique ID. Use when you need to fetch details for a specific user.
  - body: { id: string }
- `POST https://api.mcp.ai/api/parma/get/user/profile` — Tool to retrieve the authenticated user's profile. Use after obtaining a valid auth token to fetch current user account details.
- `POST https://api.mcp.ai/api/parma/list/deals` — Tool to retrieve all deals from the Parma account. Use when you need to list deals, filter by pagination, or get an overview of all deals in the system.
  - body: { page?: string }
- `POST https://api.mcp.ai/api/parma/list/groups` — Tool to retrieve all groups in the Parma account. Use when you need to list groups, optionally filtered by a search query.
  - body: { page?: string, query?: string }
- `POST https://api.mcp.ai/api/parma/list/notes` — Tool to retrieve all notes from the Parma account. Use when you need to list or search through notes associated with relationships.
  - body: { page?: string }
- `POST https://api.mcp.ai/api/parma/list/pipelines` — Tool to list all pipelines in the Parma account. Use when you need to retrieve available pipelines and their details.
- `POST https://api.mcp.ai/api/parma/list/relationship/groups` — Tool to retrieve all groups linked to a specific relationship. Use when you need to see which groups are associated with a given relationship ID.
  - body: { relationship_id: string }
- `POST https://api.mcp.ai/api/parma/list/relationship/notes` — Tool to list all notes linked to a relationship. Use when you need to retrieve all notes associated with a specific relationship ID.
  - body: { page?: string, relationship_id: string }
- `POST https://api.mcp.ai/api/parma/list/relationships` — Tool to list all relationships in the Parma account. Use when you need to retrieve and filter relationships by various criteria such as name, type, or contact details.
  - body: { sms?: string, name?: string, page?: string, type?: string, email?: string, phone?: string, twitter?: string, linkedin?: string, telegram?: string, whatsapp?: string, instagram?: string, schedulinglink?: string }
- `POST https://api.mcp.ai/api/parma/list/stages` — Tool to retrieve all stages in the Parma account. Use when you need to list pipeline stages or check available stage configurations.
- `POST https://api.mcp.ai/api/parma/list/users` — Tool to list all users in the Parma account. Use when you need to retrieve the complete list of users with their IDs, names, and email addresses.
  - body: { page?: string }
- `POST https://api.mcp.ai/api/parma/package/list` — Tool to retrieve all dataset identifiers from the Parma CKAN instance. Use when you need to list every available dataset ID.
- `POST https://api.mcp.ai/api/parma/remove/relationship/from/group` — Tool to remove a relationship from a group. Use when you need to dissociate a relationship from a specific relationship group. Returns success status on completion (HTTP 204).
  - body: { relationship_id: string, relationship_group_id: string }
- `POST https://api.mcp.ai/api/parma/update/note` — Tool to update an existing note in the Parma account. Use when you need to modify the content, datetime, or relationships of a specific note.
  - body: { id: string, body?: string, datetime?: string, relationship_ids?: integer[] }
- `POST https://api.mcp.ai/api/parma/update/relationship` — Tool to update an existing relationship in the Parma account. Use when you need to modify relationship details such as name, description, type, or associated groups.
  - body: { id: string, name?: string, type?: string, about?: string, group_ids?: integer[], company_id?: integer, properties?: object[] }

## Example prompts
- "What can I do in Parma?"
- "Show me a summary of my Parma account"

## More
- Page: https://mcp.ai/parma
- Agent spec (llms.txt): https://mcp.ai/parma/llms.txt
- Postman collection: https://mcp.ai/parma/postman.json
