Skip to content
Documentation menu

docsPatchnet Projects

MCP tools reference

The Patchnet Projects tools a connected agent can use, grouped by purpose, with the role each one needs.


This reference lists the tools Patchnet Projects offers to connected AI tools over MCP. It is for people who set up agents or want to know what their agent can do. You do not call these tools yourself — your agent picks them based on what you ask.

Concepts

  • Project handle — tools find projects by a stable handle returned from patchnet_list_projects. Use project paths such as org/shared/ops when you talk to your agent; it maps them for you.
  • Record type — the kind of record, defined by the project. Always check it with patchnet_schema before writing.
  • Role — every tool checks your role on the project. The role each tool needs is shown in brackets.
  • Read depth — record reads can return just key fields, or the full body. Agents should read full bodies only for records they need.

Getting oriented

  • patchnet_help — built-in guidance by topic, such as getting-started, architect, roles, limits, and troubleshooting. [any]
  • patchnet_list_projects — the projects you can access, with your role on each. Call this first. [any]
  • patchnet_overview — a short summary across several projects. [Reader]
  • patchnet_announcements — recent product changes. [any]
  • patchnet_time_now — the current date and time, optionally in a given time zone. [any]

Projects and record types

  • patchnet_create_project — create a project, with a starter set or a custom design. [must be allowed to create projects]
  • patchnet_plan_project_schema — draft a starter design for a common kind of work. [any]
  • patchnet_validate_schema_pack — check a proposed design before it is used. [any]
  • patchnet_schema — the record types and fields of a project. [Reader]
  • patchnet_install_schema_pack — change the record types of an existing project. [Owner]
  • patchnet_archive_project — archive a project. Records are kept. [Admin]

Finding and reading records

  • patchnet_list_documents — a page of records of one type. [Reader]
  • patchnet_query_documents — records filtered by field values and date ranges, sorted, a page at a time. [Reader]
  • patchnet_aggregate_documents — counts, sums, and averages grouped by a field, such as open cases by status. [Reader]
  • patchnet_search_documents — search indexed values such as names, dates, and amounts. [Reader]
  • patchnet_get_document — one record, including its full body. [Reader]
  • patchnet_related_documents — records linked to a given record. [Reader]
  • patchnet_join_documents — records together with fields from the records they link to. [Reader]

Creating and updating records

  • patchnet_create_document — create a record. [Writer]
  • patchnet_update_document — update a record's fields or body. [Writer]

Write one record at a time. Patchnet accepts one write per project at a time, so an agent that sends several writes at once gets errors.

Reports

  • patchnet_report_render — preview a report from project records without saving it. [Reader]
  • patchnet_report_publish — save a report as a record you can reopen. [Writer]
  • patchnet_report_find — find saved reports. [Reader]
  • patchnet_report_refresh — refresh a saved report with current data. [Writer]

Access

  • patchnet_grant_access — give a person access to a project with a role. [Admin]
  • patchnet_revoke_access — remove a person's access. [Admin]
  • patchnet_audit — view recent activity on a project. [Admin]

Limits

Tools return an error when a request goes over a limit. If the error says how long to wait, wait that long before retrying. See Limits.

Your workspace may show additional tools that your organization has turned on. Ask your agent to run patchnet_help for guidance on any tool it sees.