{ "package": { "name": "@teamgrid/mcp-server", "sourceCommit": "b0e4b3dfa4afd74822a73b8b5e8b647236f273ce", "sourceRepository": "TeamGrid/developer-platform", "version": "1.2.2" }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "contract": { "domain": "crm-write", "concurrency": "unconditional", "idempotency": true, "coreCas": false }, "outputSchema": { "type": "object", "anyOf": [ { "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/Contact" }, "meta": { "additionalProperties": false, "properties": { "requestId": { "type": "string", "description": "Unique identifier assigned to the API request for tracing and support." }, "privateResource": { "type": "object", "additionalProperties": false, "required": [ "uri", "maxBytes", "readMethod" ], "properties": { "uri": { "type": "string", "pattern": "^teamgrid://(?:files|exports)/[A-Za-z0-9_.:%-]+$" }, "maxBytes": { "const": 1048576 }, "readMethod": { "const": "resources/read" } } }, "etag": { "type": "string", "pattern": "^\"[\\x21\\x23-\\x7e]{1,256}\"$" }, "resume": { "type": "object", "additionalProperties": false, "required": [ "tool", "arguments" ], "properties": { "tool": { "enum": [ "teamgrid_project_lifecycle_operation_get", "teamgrid_planned_work_operation_get", "teamgrid_task_recurrence_operation_get", "teamgrid_export_get" ] }, "arguments": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 } } } } }, "outcome": { "enum": [ "completed", "accepted", "partial", "unknown", "failed" ] }, "omittedFields": { "type": "array", "items": { "type": "string" } }, "contentReadTool": { "const": "teamgrid_document_get" }, "contentPage": { "type": "object", "additionalProperties": false, "properties": { "unit": { "const": "utf16" }, "offset": { "type": "integer", "minimum": 0 }, "nextOffset": { "type": [ "integer", "null" ], "minimum": 0 }, "totalLength": { "type": "integer", "minimum": 0 }, "complete": { "type": "boolean" }, "revision": { "type": [ "string", "null" ] } }, "required": [ "unit", "offset", "nextOffset", "totalLength", "complete", "revision" ] }, "search": { "type": "object", "additionalProperties": false, "properties": { "complete": { "const": false }, "indexed": { "const": true }, "returned": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 }, "continuation": { "const": "narrow-query-or-list" }, "verification": { "const": "read-by-id" } }, "required": [ "complete", "indexed", "returned", "limit", "continuation", "verification" ] } }, "required": [ "requestId" ], "type": "object", "description": "Public API representation of meta." } }, "required": [ "data", "meta" ], "type": "object" }, { "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/Contact" }, "meta": { "additionalProperties": false, "properties": { "requestId": { "type": "string", "description": "Unique identifier assigned to the API request for tracing and support." }, "privateResource": { "type": "object", "additionalProperties": false, "required": [ "uri", "maxBytes", "readMethod" ], "properties": { "uri": { "type": "string", "pattern": "^teamgrid://(?:files|exports)/[A-Za-z0-9_.:%-]+$" }, "maxBytes": { "const": 1048576 }, "readMethod": { "const": "resources/read" } } }, "etag": { "type": "string", "pattern": "^\"[\\x21\\x23-\\x7e]{1,256}\"$" }, "resume": { "type": "object", "additionalProperties": false, "required": [ "tool", "arguments" ], "properties": { "tool": { "enum": [ "teamgrid_project_lifecycle_operation_get", "teamgrid_planned_work_operation_get", "teamgrid_task_recurrence_operation_get", "teamgrid_export_get" ] }, "arguments": { "type": "object", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 } } } } }, "outcome": { "enum": [ "completed", "accepted", "partial", "unknown", "failed" ] }, "omittedFields": { "type": "array", "items": { "type": "string" } }, "contentReadTool": { "const": "teamgrid_document_get" }, "contentPage": { "type": "object", "additionalProperties": false, "properties": { "unit": { "const": "utf16" }, "offset": { "type": "integer", "minimum": 0 }, "nextOffset": { "type": [ "integer", "null" ], "minimum": 0 }, "totalLength": { "type": "integer", "minimum": 0 }, "complete": { "type": "boolean" }, "revision": { "type": [ "string", "null" ] } }, "required": [ "unit", "offset", "nextOffset", "totalLength", "complete", "revision" ] }, "search": { "type": "object", "additionalProperties": false, "properties": { "complete": { "const": false }, "indexed": { "const": true }, "returned": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 }, "continuation": { "const": "narrow-query-or-list" }, "verification": { "const": "read-by-id" } }, "required": [ "complete", "indexed", "returned", "limit", "continuation", "verification" ] } }, "required": [ "requestId" ], "type": "object", "description": "Public API representation of meta." } }, "required": [ "data", "meta" ], "type": "object" } ], "$defs": { "Contact": { "additionalProperties": false, "properties": { "attributes": { "additionalProperties": false, "properties": { "addresses": { "items": { "additionalProperties": false, "properties": { "address": { "additionalProperties": false, "properties": { "city": { "type": [ "string", "null" ], "description": "The city associated with this contact attributes addresses address." }, "country": { "type": [ "string", "null" ], "description": "The country associated with this contact attributes addresses address." }, "fullAddress": { "type": [ "string", "null" ], "description": "The full address associated with this contact attributes addresses address." }, "latitude": { "type": [ "number", "null" ], "description": "The latitude associated with this contact attributes addresses address." }, "longitude": { "type": [ "number", "null" ], "description": "The longitude associated with this contact attributes addresses address." }, "postalCode": { "type": [ "string", "null" ], "description": "The postal code associated with this contact attributes addresses address." }, "state": { "type": [ "string", "null" ], "description": "Canonical lifecycle state of the resource or operation." }, "street": { "type": [ "string", "null" ], "description": "The street associated with this contact attributes addresses address." }, "streetNumber": { "type": [ "string", "null" ], "description": "The street number associated with this contact attributes addresses address." } }, "required": [ "city", "country", "fullAddress", "latitude", "longitude", "postalCode", "state", "street", "streetNumber" ], "type": "object", "description": "The address associated with this contact attributes addresses." }, "type": { "maxLength": 100, "type": "string", "description": "Canonical type discriminator for this resource." } }, "required": [ "address", "type" ], "type": "object" }, "maxItems": 100, "type": "array", "description": "The addresses associated with this contact attributes." }, "archived": { "type": "boolean", "description": "Whether this resource is archived." }, "birthday": { "format": "date-time", "type": [ "string", "null" ], "description": "ISO 8601 timestamp for birthday." }, "category": { "type": [ "string", "null" ], "description": "The category associated with this contact attributes." }, "companies": { "items": { "additionalProperties": false, "properties": { "address": { "anyOf": [ { "additionalProperties": false, "properties": { "city": { "type": [ "string", "null" ], "description": "The city associated with this contact attributes companies address." }, "country": { "type": [ "string", "null" ], "description": "The country associated with this contact attributes companies address." }, "fullAddress": { "type": [ "string", "null" ], "description": "The full address associated with this contact attributes companies address." }, "latitude": { "type": [ "number", "null" ], "description": "The latitude associated with this contact attributes companies address." }, "longitude": { "type": [ "number", "null" ], "description": "The longitude associated with this contact attributes companies address." }, "postalCode": { "type": [ "string", "null" ], "description": "The postal code associated with this contact attributes companies address." }, "state": { "type": [ "string", "null" ], "description": "Canonical lifecycle state of the resource or operation." }, "street": { "type": [ "string", "null" ], "description": "The street associated with this contact attributes companies address." }, "streetNumber": { "type": [ "string", "null" ], "description": "The street number associated with this contact attributes companies address." } }, "required": [ "city", "country", "fullAddress", "latitude", "longitude", "postalCode", "state", "street", "streetNumber" ], "type": "object" }, { "type": "null" } ], "description": "The address associated with this contact attributes companies." }, "companyId": { "maxLength": 128, "type": [ "string", "null" ], "description": "The company id associated with this contact attributes companies." }, "email": { "type": [ "string", "null" ], "description": "Email address associated with this record." }, "phone": { "type": [ "string", "null" ], "description": "The phone associated with this contact attributes companies." }, "position": { "type": [ "string", "null" ], "description": "The position associated with this contact attributes companies." } }, "required": [ "address", "companyId", "email", "phone", "position" ], "type": "object" }, "maxItems": 100, "type": "array", "description": "The companies associated with this contact attributes." }, "companyTitle": { "type": "string", "description": "The company title associated with this contact attributes." }, "createdAt": { "format": "date-time", "type": [ "string", "null" ], "description": "Timestamp at which the resource was created." }, "createdById": { "type": [ "string", "null" ], "description": "The created by id associated with this contact attributes." }, "customerId": { "type": [ "string", "null" ], "description": "The customer id associated with this contact attributes." }, "emails": { "items": { "additionalProperties": false, "properties": { "email": { "type": "string", "description": "Email address associated with this record." }, "type": { "type": "string", "description": "Canonical type discriminator for this resource." } }, "required": [ "email", "type" ], "type": "object" }, "type": "array", "description": "The emails associated with this contact attributes." }, "employeesCount": { "minimum": 0, "type": "integer", "description": "Number of employees records represented by this contact attributes." }, "firstName": { "type": "string", "description": "The first name associated with this contact attributes." }, "gender": { "type": [ "string", "null" ], "description": "The gender associated with this contact attributes." }, "groupId": { "type": [ "string", "null" ], "description": "Identifier of the related workspace group." }, "lastActivityAt": { "format": "date-time", "type": [ "string", "null" ], "description": "ISO 8601 timestamp for last activity at." }, "lastName": { "type": "string", "description": "The last name associated with this contact attributes." }, "nickname": { "type": "string", "description": "The nickname associated with this contact attributes." }, "notes": { "type": "string", "description": "The notes associated with this contact attributes." }, "parentContactId": { "type": [ "string", "null" ], "description": "The parent contact id associated with this contact attributes." }, "phoneNumbers": { "items": { "additionalProperties": false, "properties": { "number": { "type": "string", "description": "The number associated with this contact attributes phone numbers." }, "type": { "type": "string", "description": "Canonical type discriminator for this resource." } }, "required": [ "number", "type" ], "type": "object" }, "type": "array", "description": "The phone numbers associated with this contact attributes." }, "projectsCompleted": { "minimum": 0, "type": "integer", "description": "The projects completed associated with this contact attributes." }, "projectsOpen": { "minimum": 0, "type": "integer", "description": "The projects open associated with this contact attributes." }, "projectsTotal": { "minimum": 0, "type": "integer", "description": "The projects total associated with this contact attributes." }, "salutation": { "type": "string", "description": "The salutation associated with this contact attributes." }, "socialNetworks": { "items": { "additionalProperties": false, "properties": { "type": { "maxLength": 100, "type": "string", "description": "Canonical type discriminator for this resource." }, "username": { "maxLength": 1000, "type": "string", "description": "The username associated with this contact attributes social networks." } }, "required": [ "type", "username" ], "type": "object" }, "maxItems": 100, "type": "array", "description": "The social networks associated with this contact attributes." }, "tasksCompleted": { "minimum": 0, "type": "integer", "description": "The tasks completed associated with this contact attributes." }, "tasksOpen": { "minimum": 0, "type": "integer", "description": "The tasks open associated with this contact attributes." }, "tasksTotal": { "minimum": 0, "type": "integer", "description": "The tasks total associated with this contact attributes." }, "type": { "enum": [ "person", "company" ], "type": "string", "description": "Canonical type discriminator for this resource." }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ], "description": "Timestamp of the most recent successful update." }, "updatedById": { "type": [ "string", "null" ], "description": "The updated by id associated with this contact attributes." }, "websites": { "items": { "additionalProperties": false, "properties": { "type": { "maxLength": 100, "type": "string", "description": "Canonical type discriminator for this resource." }, "url": { "maxLength": 2048, "type": "string", "description": "HTTPS URL associated with the resource." } }, "required": [ "type", "url" ], "type": "object" }, "maxItems": 100, "type": "array", "description": "The websites associated with this contact attributes." } }, "required": [ "addresses", "archived", "birthday", "category", "companies", "companyTitle", "createdAt", "createdById", "customerId", "emails", "employeesCount", "firstName", "gender", "groupId", "lastActivityAt", "lastName", "nickname", "notes", "parentContactId", "phoneNumbers", "projectsCompleted", "projectsOpen", "projectsTotal", "salutation", "socialNetworks", "tasksCompleted", "tasksOpen", "tasksTotal", "type", "updatedAt", "updatedById", "websites" ], "type": "object", "description": "The attributes associated with this contact." }, "id": { "type": "string", "description": "Stable TeamGrid identifier for this resource." }, "type": { "const": "contact", "description": "Canonical type discriminator for this resource." } }, "required": [ "type", "id", "attributes" ], "type": "object", "description": "Public API representation of contact." } } }, "profileOutputSchemas": {}, "exposure": "gated-write", "apiOperations": [ { "href": "/api/v1/reference/operations/createcontact/", "method": "POST", "operationId": "createContact", "path": "/contacts" } ], "availableIn": [ "full", "crm-write" ], "baseProfile": "full", "description": "Create a contact. Changes the selected workspace under current API permissions. Reuse the same idempotencyKey and payload for the same intent.", "inputSchema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 1, "maxLength": 128, "description": "Workspace returned by teamgrid_workspace_get and selected for this exact action." }, "idempotencyKey": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$", "description": "Stable key for this exact intent. Retain and reuse the same key and payload after a timeout; a timeout does not prove failure." }, "data": { "additionalProperties": false, "properties": { "birthday": { "format": "date-time", "type": [ "string", "null" ], "description": "ISO 8601 timestamp for birthday." }, "category": { "enum": [ "customer", "supplier", null ], "type": [ "string", "null" ], "description": "Canonical category value for this contact." }, "companyTitle": { "maxLength": 500, "type": [ "string", "null" ], "description": "The company title associated with this contact." }, "customerId": { "maxLength": 500, "type": [ "string", "null" ], "description": "The customer id associated with this contact." }, "emails": { "items": { "additionalProperties": false, "properties": { "email": { "maxLength": 500, "minLength": 1, "type": "string", "description": "Email address associated with this record." }, "type": { "enum": [ "business", "other", "private" ], "type": "string", "description": "Canonical type discriminator for this resource." } }, "required": [ "email", "type" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ], "description": "The emails associated with this contact." }, "firstName": { "maxLength": 500, "type": [ "string", "null" ], "description": "The first name associated with this contact." }, "gender": { "enum": [ "female", "male", null ], "type": [ "string", "null" ], "description": "Canonical gender value for this contact." }, "groupId": { "maxLength": 128, "type": [ "string", "null" ], "description": "Identifier of the related workspace group." }, "lastName": { "maxLength": 500, "type": [ "string", "null" ], "description": "The last name associated with this contact." }, "nickname": { "maxLength": 500, "type": [ "string", "null" ], "description": "The nickname associated with this contact." }, "notes": { "maxLength": 50000, "type": [ "string", "null" ], "description": "The notes associated with this contact." }, "parentContactId": { "maxLength": 128, "type": [ "string", "null" ], "description": "The parent contact id associated with this contact." }, "phoneNumbers": { "items": { "additionalProperties": false, "properties": { "number": { "maxLength": 500, "minLength": 1, "type": "string", "description": "The number associated with this contact phone numbers." }, "type": { "enum": [ "business", "direct", "fax", "landline", "mobile", "other" ], "type": "string", "description": "Canonical type discriminator for this resource." } }, "required": [ "number", "type" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ], "description": "The phone numbers associated with this contact." }, "salutation": { "maxLength": 500, "type": [ "string", "null" ], "description": "The salutation associated with this contact." }, "type": { "enum": [ "company", "person" ], "type": "string", "description": "Canonical type discriminator for this resource." } }, "required": [ "type" ], "type": "object", "description": "Public API representation of contact." } }, "required": [ "workspaceId", "idempotencyKey", "data" ], "additionalProperties": false }, "profileInputSchemas": {}, "name": "teamgrid_contact_create", "scopes": { "optional": [], "conditional": [], "required": [ "contacts:write", "workspace:read" ] }, "security": { "classification": "workspace-mutation", "summary": "This changes workspace state and may trigger business or external effects. Use its exact scope, revision and idempotency contract; profile selection grants no authority." }, "output": { "format": "A compact mutation receipt includes target and revision when available; outcome metadata distinguishes accepted, complete, partial and uncertain results.", "kind": "mutation-receipt", "maxSerializedBytes": 262144, "pagination": null, "redactions": [], "searchLimit": null }, "examplePrompt": "Prepare a teamgrid_contact_create operation for my chosen target. Resolve IDs, read current state and revisions, show the intended change, then report its confirmed or uncertain outcome without automatic retries.", "typicalErrors": [ { "condition": "The selected tool profile or allow/deny filter excludes `teamgrid_contact_create`.", "result": "The tool is not advertised to the host. Select the narrowest profile that contains it and restart the host." }, { "condition": "An argument violates this tool’s input schema: required field, type, enum, pattern, length, or range.", "result": "MCP input validation rejects the call before an API request is made." }, { "condition": "The credential lacks `contacts:write` and `workspace:read` or cannot access the requested resource.", "result": "The tool preserves a safe API error code such as `insufficient_scope`, with redacted detail and available status/request metadata." }, { "condition": "The connection ends while awaiting the write result.", "result": "Inspect the outcome and status/resume information. An interrupted wait does not prove rollback; never blindly repeat the write." }, { "condition": "An unknown input property is supplied.", "result": "The strict input schema rejects the call before an API request is made." } ] }