> For the complete documentation index, see [llms.txt](https://support.attackforge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.attackforge.com/app/modules/ai-mcp-and-skills/find-project-scope.md).

# Find Project Scope

#### Description <a href="#description" id="description"></a>

Lists Project Scope items belonging to one AttackForge project. A Project Scope item represents one thing within the testing scope of that project (a URL, host, application, etc.). Use this to retrieve the items themselves - call `count_project_scope` when only a total is needed. The caller must have at least View access to the project. The fields `asset_id`, `asset_type`, `external_asset_id`, and `details` are only populated when the Assets module is enabled (these come from the linked Asset). Results are paginated (default 10 per page, max 50).

#### How To Enable <a href="#how-to-enable" id="how-to-enable"></a>

1. Go to `Users`
2. Select the user you would like to provide access to this tool
3. Click on `Access > MCP`
4. Click on `Add Tools`
5. Select the tool `find_project_scope` and click `Add`

#### Example Prompts <a href="#example-prompts" id="example-prompts"></a>

* *Show me the scope for project X.*
* *List the in-scope hosts for the ACME project with their details.*
* *Which scope items in project X are linked to assets?*
* *Find scope items containing "api" in project X.*

#### Parameters <a href="#parameters" id="parameters"></a>

| Parameter           | Type    | Required | Description                                                                                                                                                                                     |
| ------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `project_id`        | string  | Yes      | The id (24-hex) of the project whose scope you want to list. Obtain it from `find_projects`. The caller must have View access or higher.                                                        |
| `filter`            | object  | No       | A MongoDB-style filter. Supported fields are listed below.                                                                                                                                      |
| `fields`            | array   | No       | System fields to include (`id` is always returned). Supported values are listed below.                                                                                                          |
| `custom_field_keys` | array   | No       | Custom field keys to include. Project Scope items inherit the custom fields of the underlying Asset model (requires the Assets module). Discover keys via `get_field_structure(model="asset")`. |
| `limit`             | integer | No       | Maximum records to return in this page. Default 10, max 50.                                                                                                                                     |
| `skip`              | integer | No       | Number of records to skip (offset). Default 0.                                                                                                                                                  |

**Supported `filter` fields:**

| Field      | Type                   | Description                                                                                                  |
| ---------- | ---------------------- | ------------------------------------------------------------------------------------------------------------ |
| `id`       | `ObjectId('<24 hex>')` | the Project Scope item id                                                                                    |
| `name`     | string                 | the scope item name (URL, host, application, etc.)                                                           |
| `asset_id` | `ObjectId('<24 hex>')` | id of the linked Asset (only set when the Assets module is enabled and the scope item is linked to an Asset) |

> `asset_id`, `asset_type`, `external_asset_id`, and `details` require the Assets module to be enabled - they are empty otherwise.

**Supported `fields` values:**

| Field               | Type   |
| ------------------- | ------ |
| `id`                | string |
| `name`              | string |
| `asset_id`          | string |
| `asset_type`        | string |
| `external_asset_id` | string |
| `details`           | string |

#### Example Response

```json
{
  "data": [
    {
      "id": "66a440c08cade68ca7bc7192",
      "name": "https://app.acme.example",
      "asset_id": "64e17a99009140000f4acf70",
      "asset_type": "Web Application",
      "external_asset_id": "CMDB-987",
      "details": "Primary customer-facing web application",
      "custom_fields": [
        {
          "key": "internet_facing",
          "value": "Yes",
          "label": "Internet Facing"
        }
      ]
    }
  ],
  "count": 1,
  "total": 1
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://support.attackforge.com/app/modules/ai-mcp-and-skills/find-project-scope.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.