For the complete documentation index, see llms.txt. This page is also available as Markdown.

Find Project Test Case Workspace Notes

Description

Lists the workspace notes recorded against the test cases of one AttackForge project. A workspace note is reference material useful for performing the test case - background, tips, payloads, or anything else worth having to hand while testing it. It is not a record of testing progress: for that, use find_project_testcase_notes instead.

Unlike a note, a workspace note has a plain-text title as well as rich-text content. It may carry attached files; each is listed in files and can be fetched with get_file. Workspace notes live here rather than on find_project_testcases because one test case can carry many of them.

The caller must have access to the project's test cases. Results are paginated (default 10 per page, max 50).

How To Enable

  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_testcase_workspace_notes and click Add

Example Prompts

  • Show me the workspace notes for this test case.

  • What reference material do I have for testing project X?

  • Find the workspace note with the payload list.

  • Show me the workspace notes titled "Setup".

  • List the files attached to the workspace notes on this test case.

Parameters

Parameter
Type
Required
Description

project_id

string

Yes

Id (24-hex) of the project whose test case workspace notes you want to list. Source: find_projects. The caller must have access to this project's test cases.

project_testcase_ids

array

No

Restrict the results to these project test cases (array of 24-hex ids). Source: find_project_testcases (its id field). Omit to return workspace notes across every test case in the project. Ids that do not belong to this project are ignored.

filter

object

No

A MongoDB-style filter, applied on top of project_id and project_testcase_ids. Supported fields are listed below.

fields

array

No

Fields to include on each workspace note (id is always returned). Supported values are listed below.

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 / Values

id

ObjectId('<24 hex>')

project_testcase_id

ObjectId('<24 hex>')

created, modified

ISO-8601 datetime

title

string

note

string

user_id

ObjectId('<24 hex>')

Workspace notes are stored as AttackForge richtext (HTML), so a $regex on note matches the markup as stored, not the rendered text. Keep patterns to plain words to avoid matching tags. title is plain text and has no such caveat.

Supported fields values:

Field
Type

id

string

project_testcase_id

string

created, modified

ISO-8601 datetime

title

string

note

string (AttackForge richtext)

user_id

string

files

array of { id, created, modified, name, mimeType, hash, size, storage_name, storage_location }

Example Response

Last updated