Postman

Official

Overview Schema Related Servers Score Discussions

searchPostmanElements

Read-onlyIdempotent

Search Postman entities (requests, collections, workspaces, specs, flows, environments, mocks) using filters for ownership, visibility, and workspace.

Instructions

Search for Postman entities (requests, collections, workspaces, specs, flows, environments, and mocks).

Ownership:

organization — Search within all resources owned by your organization (default).
external — Search within the public Postman network (third-party and community APIs).
all — Search across all scopes.

When to use each ownership value and filters:

Goal	Recommended approach
Find an internal API (e.g. "our notification service")	`ownership: organization`
Find a trusted API published to the Private Network	`ownership: organization` + `privateNetwork: true` filter
Find an internal API in all resources of organization and are visible to the organization only	`ownership: organization` + `visibility: internal` filter
Find an API by your organization that is made publicly visible	`ownership: organization` + `visibility: public` filter
Find a third party publicly visible API (e.g. "Stripe API", "Twilio API")	`ownership: external` + `visibility: public` filter
User says "our APIs", "internal", "team"	`ownership: organization`
Search across all scopes	`ownership: all`

Element Types:

requests: Search for individual API requests.
collections: Search for API collections.
workspaces: Search for Postman workspaces.
specs: Search for API specifications.
flows: Search for Postman Flows.
environments: Search for Postman Environments.
mocks: Search for Postman Mock Servers.

Filters:

Use the filters parameter to narrow results. The top-level key must be $and with an array of condition objects. Each condition object must contain exactly one field key.

Supported filter fields:

Field	Operators	Notes
`workspaceId`	`$eq`, `$ne`, `$in`, `$nin`	All element types. `$in`/`$nin` accept arrays.
`collectionId`	`$eq`, `$ne`, `$in`, `$nin`	Requests and collections only.
`visibility`	`$eq`, `$ne`	Values: `public`, `partner`, `internal`. All element types.
`privateNetwork`	`$eq`, `$ne`	Boolean. All element types.
`publisherIsVerified`	`$eq`, `$ne`	Boolean. All element types.
`method`	`$eq`, `$ne`, `$in`, `$nin`	HTTP methods (GET, POST, etc.). Requests only.
`tags`	`$eq`, `$ne`, `$in`, `$nin`	Workspaces and collections only.
`requestId`	`$eq`, `$ne`, `$in`, `$nin`	Requests only.
`specificationId`	`$eq`, `$ne`, `$in`, `$nin`	Specs only.
`flowId`	`$eq`, `$ne`, `$in`, `$nin`	Flows only.
`createdBy`	`$eq`, `$ne`, `$in`, `$nin`	All element types.
`organizationId`	`$eq`, `$ne`, `$in`, `$nin`	All element types.
`teamId`	`$eq`, `$ne`, `$in`, `$nin`	All element types.
`isGitConnected`	`$eq`, `$ne`	Boolean. Workspaces, collections, requests, specs, flows, environments, mocks.
`type`	`$eq`, `$ne`, `$in`, `$nin`	Requests only.

Filter examples:

Private API Network only: {"$and":[{"privateNetwork":{"$eq":true}}]}
Single workspace: {"$and":[{"workspaceId":{"$eq":"ws-abc123"}}]}
Multiple workspaces: {"$and":[{"workspaceId":{"$in":["ws-1","ws-2"]}}]}
Public visibility: {"$and":[{"visibility":{"$eq":"public"}}]}
GET requests only: {"$and":[{"method":{"$eq":"GET"}}]}
Combine conditions: {"$and":[{"visibility":{"$eq":"public"}},{"workspaceId":{"$eq":"ws-abc123"}}]}
Environments in a workspace: {"$and":[{"workspaceId":{"$eq":"ws-abc123"}}]}

Input Schema

TableJSON Schema

Name	Required	Description	Default
`entityType`	No	The type of Postman entity to search for: `requests` (individual API requests), `collections` (API collections), `workspaces` (Postman workspaces), `specs` (API specifications), `flows` (Postman Flows), `environments` (Postman Environments), or `mocks` (Postman Mock Servers).	requests
`q`	No	The search query (e.g. "payment API", "notification service", "Stripe").
`ownership`	No	The ownership scope. Use `organization` to search all resources in your organization (default), `external` to search the public Postman network, or `all` to search across all scopes.	organization
`filters`	No	Structured filter expression. Top-level key must be "$and" with an array of condition objects. Each condition: { "<field>": { "<operator>": <value> } }. Example: {"$and":[{"privateNetwork":{"$eq":true}}]}
`cursor`	No	The cursor to get the next set of results in the paginated response. Pass the `nextCursor` value from the previous response.
`limit`	No	The maximum number of search results to return. Maximum: 25.

Tool Definition Quality

A4.3/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds behavioral details such as the search scope (ownership), filter structure, pagination via cursor/limit, and default values. It does not contradict annotations. The additional context on filter operators and examples goes beyond the annotations, though it omits potential side-effects or rate limits, which are minor for a read-only search.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is quite lengthy, spanning multiple lines with tables and lists. While well-structured with headings and markdown, it could be more concise. The first sentence clearly states the purpose, but subsequent sections add bulk. Not every sentence is essential; the filter examples, for instance, are extensive. A more streamlined version would improve conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (6 parameters, nested filter object), the description covers ownership, element types, filter fields, operators, and pagination. However, it lacks details about the return format (structure of search results) since no output schema is provided. The mention of 'nextCursor' hints at paginated results, but the fields per entity type are not described. This is a minor gap for a search tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with descriptions for all parameters. The description adds significant value beyond the schema: it explains the ownership parameter with a usage table, lists element types with examples, provides filter syntax and examples, and clarifies pagination. This enriches the schema's basic descriptions, making it easy for an agent to construct correct queries.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description starts with a clear verb and scope: 'Search for Postman entities'. It lists all entity types explicitly, and the detail on ownership and filters distinguishes this from sibling tools like getCollection (which retrieves a specific entity by ID) and create* tools. The purpose is unambiguous and well-defined.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description includes a table titled 'When to use each ownership value and filters' that provides specific scenarios (e.g., 'Find an internal API') with recommended ownership and filter combinations. This offers clear context on usage. However, it does not explicitly state when not to use this tool or directly compare to alternatives like getCollections, though the filtering and search nature imply the distinction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Latest Blog Posts

Lightport: Open-Sourcing Glama's AI Gateway
By punkpeye on April 27, 2026.
open source
OpenAI
Tool Definition Quality Score (TDQS)
By punkpeye on April 3, 2026.
mcp
The Hackers Who Tracked My Sleep Cycle
By punkpeye on March 26, 2026.
security

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/postmanlabs/postman-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server