# RevCent MCP Guide: `GetProject`

Brief AI/MCP-focused guide for retrieving one RevCent Project.

---

## Related Documentation

| Guide | Link | Why It Matters |
|---|---|---|
| Project Overview | `https://revcent.com/documentation/markdown/mcp/operation/OverviewProject.md` | Explains Projects as durable AI/MCP pseudo repositories and how Project entities and Project Notes work together. |
| GetProjects | `https://revcent.com/documentation/markdown/mcp/operation/GetProjects.md` | Retrieve a paginated list of Projects when the Project ID is not already known. |
| SearchProjects | `https://revcent.com/documentation/markdown/mcp/operation/SearchProjects.md` | Search Projects by name, description, or associated entity ID when a direct Project ID is not known. |
| GetProjectNotes | `https://revcent.com/documentation/markdown/mcp/operation/GetProjectNotes.md` | Retrieve Project Note titles and metadata for a Project before deciding which full notes to fetch. |
| GetProjectNote | `https://revcent.com/documentation/markdown/mcp/operation/GetProjectNote.md` | Retrieve the full content of a specific Project Note. |
| CreateProjectNote | `https://revcent.com/documentation/markdown/mcp/operation/CreateProjectNote.md` | Record meaningful Project context, decisions, entity changes, and follow-up work. |
| SearchProjectNotes | `https://revcent.com/documentation/markdown/mcp/operation/SearchProjectNotes.md` | Search Project Notes by keyword or phrase, optionally within a specific Project, when note content or history needs to be found quickly. |

---

## Operation Summary

Operation:

```text
GetProject
```

Purpose:

```text
Retrieve one Project by Project ID, including the Project name, description, timestamps, and associated entities grouped by entity type.
```

Use `GetProject` when AI/MCP already has a `project_id` and needs to inspect the Project's durable context container before acting.

If the Project ID is not known, use `SearchProjects` when a keyword, phrase, Project name, Project description, or associated entity ID may identify the Project. Use `GetProjects` when a paginated list is more appropriate.

---

## Input Schema

| Field | Type | Required | Description |
|---|---:|---:|---|
| `project_id` | string | Yes | 20-character Project ID. |

Example:

```json
{
  "project_id": "XXXXXXXXXXXXXXXXXXXX"
}
```

---

## Output Summary

`GetProject` can return:

| Field | Meaning |
|---|---|
| `api_call_id` | 20-character API call ID. |
| `api_call_unix` | Unix timestamp when the API call was initiated. |
| `code` | API response code. `1` indicates success. |
| `id` | 20-character Project ID. |
| `name` | Project name. |
| `description` | Project description. |
| `created_date_unix` | Project creation timestamp. |
| `updated_date_unix` | Project update timestamp. |
| `entities` | Associated RevCent entities grouped by entity type. |

---

## Associated Entities

The `entities` object gives AI/MCP a quick map of what belongs to the Project.

Entity groups can include items such as:

```text
ai_assistant
ai_prompt
ai_voice_agent
ai_voice_snippet
bin_profile
campaign
customer_group
customer_portal
email_template
fulfillment_account
function
gateway
gateway_group
key_value
payment_profile
paypal_account
product
product_group
shipping_profile
smtp_profile
subscription_profile
tax_profile
third_party_integration
third_party_shop
tracking_domain
url_parameter_set
```

Each entity group usually includes:

| Field | Meaning |
|---|---|
| `count` | Total number of associated entities of that type. |
| `items` | Lightweight associated entity records, usually including ID, name, description, and timestamps. |

Important:

```text
GetProject returns an overview of associated entities, not complete details for every associated entity.
Use the entity's specific Get operation to retrieve full details.
```

Examples:

```text
GetProject returns a product ID
    ↓
Use GetProduct for full Product details

GetProject returns an AI Assistant ID
    ↓
Use GetAIAssistant for full AI Assistant details

GetProject returns a payment profile ID
    ↓
Use GetPaymentProfile for full Payment Profile details
```

For products, the Project response may return a limited set of product items to reduce token usage, while `count` can indicate the total number of associated Products.

---

## When to Use

Use `GetProject` when:

- a Project ID is already known,
- AI/MCP needs to inspect Project name and description,
- associated entities need to be identified before acting,
- AI/MCP needs to understand what RevCent objects belong to a Project,
- a workflow should verify that an entity belongs to the expected Project,
- Project Notes should be retrieved after confirming the relevant Project.

---

## Recommended Workflow

```text
1. If the Project ID is unknown, use SearchProjects or GetProjects.
2. Run GetProject with the selected project_id.
3. Review the Project name and description to confirm scope.
4. Review associated entities to understand what belongs to the Project.
5. Use entity-specific Get operations for any associated entities that need full detail.
6. Use GetProjectNotes with project_filter to review recent Project Note titles and metadata.
7. Use GetProjectNote for specific notes whose full content is needed.
8. Continue the requested work only after the Project context is clear.
```

---

## Common Mistakes to Avoid

Do not:

- use `GetProject` when the Project ID is unknown; use `SearchProjects` or `GetProjects` first,
- treat associated entity summaries as full entity details,
- modify Project-related configuration without reviewing the Project description and relevant notes,
- assume entity association alone explains why an entity matters,
- ignore `count` values when an entity group may contain more items than are returned in the lightweight response,
- confuse `GetProject` with `EditProject`; `GetProject` retrieves Project context and does not modify anything.

---

## Final AI/MCP Instruction

Use `GetProject` to retrieve a single Project's core context and associated entity map by `project_id`. Treat the Project description as the README-like purpose statement and the `entities` object as a lightweight index of related RevCent objects. Use `SearchProjects` or `GetProjects` first when the Project ID is unknown, then use Project Notes and entity-specific Get operations for deeper context before making meaningful changes.


---
Document Parent Directory
* [Operations](https://revcent.com/documentation/markdown/mcp/operation/index.md) - AI/MCP details and overviews for operations available within the RevCent MCP.