postman-mcp
Provides tools for managing Postman collections, environments, mock servers, API specifications, and workspaces through the Postman API.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@postman-mcplist my workspaces"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Postman MCP Server
A production-ready Model Context Protocol (MCP) server that provides 41 Postman API tools for managing collections, environments, mocks, API specifications, and workspaces. Supports Streamable HTTP, SSE, and stdio transports.
Features
š¦ 41 Postman API Tools - Complete Postman API automation
š Multiple Transports - Streamable HTTP, SSE, and stdio support
š Production Ready - Docker support with proper error handling
š Collections - Create, read, update, duplicate collections
š Environments - Manage environment variables
š Mocks - Create and manage mock servers
š API Specs - OpenAPI, AsyncAPI, protobuf, GraphQL support
š¢ Workspaces - Manage team and personal workspaces
š Integration - Sync specs with collections
Available Tools (41)
Collections (7 tools)
createCollection- Create a collection (v2.1.0 format)getCollection- Get collection info (map/minimal/full)getCollections- List workspace collectionsputCollection- Replace collection contentsduplicateCollection- Duplicate to another workspacegetDuplicateCollectionTaskStatus- Check duplication status
Requests & Responses (3 tools)
createCollectionRequest- Create request in collectionupdateCollectionRequest- Update existing requestcreateCollectionResponse- Create request response
Environments (4 tools)
createEnvironment- Create environmentgetEnvironment- Get environment detailsgetEnvironments- List all environmentsputEnvironment- Replace environment contents
Mock Servers (5 tools)
createMock- Create mock servergetMock- Get mock server detailsgetMocks- List all mock serversupdateMock- Update mock serverpublishMock- Publish mock server (set public)
API Specifications (9 tools)
createSpec- Create API spec (OpenAPI/AsyncAPI/protobuf/GraphQL)getSpec- Get spec detailsgetAllSpecs- List workspace specsupdateSpecProperties- Update spec propertiesgetSpecDefinition- Get complete spec definitioncreateSpecFile- Create spec filegetSpecFiles- List all spec filesgetSpecFile- Get file contentsupdateSpecFile- Update spec file
Spec-Collection Integration (4 tools)
generateCollection- Generate collection from specgetSpecCollections- List spec's generated collectionsgenerateSpecFromCollection- Generate spec from collectiongetGeneratedCollectionSpecs- Get collection's generated specssyncCollectionWithSpec- Sync collection with specsyncSpecWithCollection- Sync spec with collection
Workspaces (4 tools)
createWorkspace- Create workspacegetWorkspace- Get workspace detailsgetWorkspaces- List all workspacesupdateWorkspace- Update workspace properties
Other (4 tools)
getAuthenticatedUser- Get current user infogetTaggedEntities- Get entities by tag (Enterprise)runCollection- Run collection with NewmangetEnabledTools- List enabled tools
Quick Start
Prerequisites
Required:
Postman API Key - Get from https://postman.com/settings/me/api-keys
Python 3.10+
Installation
cd postman-tool
# Install in editable mode
pip install -e .
# Verify installation
postman-mcp --helpEnvironment Variables
Required:
export POSTMAN_API_KEY="your_postman_api_key"Windows PowerShell:
$env:POSTMAN_API_KEY = "your_postman_api_key"Run Server
Streamable HTTP (Recommended):
postman-mcp --mode streamable-http --port 8010SSE:
postman-mcp --mode sse --port 8010Stdio (for MCP clients):
postman-mcp --mode stdioDocker
# Build image
docker build -t postman-mcp .
# Run container
docker run -e POSTMAN_API_KEY=your_key -p 8010:8010 postman-mcpMCP Client Configuration
Streamable HTTP
{
"mcpServers": {
"postman": {
"type": "streamable-http",
"url": "http://localhost:8010/mcp"
}
}
}Stdio
{
"mcpServers": {
"postman": {
"command": "postman-mcp",
"args": ["--mode", "stdio"],
"env": {
"POSTMAN_API_KEY": "your_postman_api_key"
}
}
}
}Usage Examples
Get Current User
await call_tool("getAuthenticatedUser", {})List Workspaces
# List my personal workspaces
user = await call_tool("getAuthenticatedUser", {})
workspaces = await call_tool("getWorkspaces", {
"createdBy": user["user"]["id"],
"type": "personal",
"limit": 100
})Create Collection
await call_tool("createCollection", {
"workspace": "workspace-id",
"collection": {
"info": {
"name": "My API Collection",
"description": "Collection for testing",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": []
}
})Get Collection
# Get lightweight map (default)
await call_tool("getCollection", {
"collectionId": "12345-abc123def456"
})
# Get full payload
await call_tool("getCollection", {
"collectionId": "12345-abc123def456",
"model": "full"
})Create Mock Server
await call_tool("createMock", {
"workspace": "workspace-id",
"mock": {
"name": "My Mock Server",
"collection": "12345-abc123def456", # Collection UID
"environment": "env-id",
"private": false
}
})Create API Specification
await call_tool("createSpec", {
"workspaceId": "workspace-id",
"name": "My API",
"type": "openapi",
"files": [
{
"path": "openapi.yaml",
"content": "openapi: 3.0.0\ninfo:\n title: My API\n version: 1.0.0"
}
]
})Generate Collection from Spec
await call_tool("generateCollection", {
"specId": "spec-id",
"name": "Generated Collection",
"elementType": "collection",
"options": {
"requestParametersResolution": "example",
"exampleParametersResolution": "example"
}
})Create Environment
await call_tool("createEnvironment", {
"workspace": "workspace-id",
"environment": {
"name": "Production",
"values": [
{"key": "base_url", "value": "https://api.example.com", "enabled": true},
{"key": "api_key", "value": "secret", "enabled": true, "type": "secret"}
]
}
})Run Collection
await call_tool("runCollection", {
"collectionId": "12345-abc123def456",
"environmentId": "env-id",
"iterationCount": 1,
"requestTimeout": 30000
})API Endpoints
When running with HTTP transports:
GET /- Server infoGET /health- Health check/mcp/*- MCP protocol endpoints (streamable-http)/sse- SSE endpoint/messages- SSE messages endpoint
Development
Run Tests
pytestProject Structure
postman-tool/
āāā postman_server.py # Main MCP server
āāā tools/
ā āāā toolhandler.py # Base class
ā āāā postman_tools.py # All 41 tool implementations
āāā tests/
ā āāā test_postman.py
āāā pyproject.toml
āāā Dockerfile
āāā README.mdPostman API Details
Authentication
Uses X-Api-Key header with your Postman API key. Get yours at: https://postman.com/settings/me/api-keys
Base URL
https://api.getpostman.comCollection UID Format
Many endpoints require collection UID in format: <OWNER_ID>-<COLLECTION_ID>
To get the UID:
Use
getCollectionand read theuidfieldConstruct from
{ownerId}-{collectionId}where:For team collections:
ownerId = me.teamId(fromgetAuthenticatedUser)For personal collections:
ownerId = me.user.id(fromgetAuthenticatedUser)
Rate Limits
Postman API has rate limits. See: https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/
Common Issues
Authentication Error
Error: Postman API error (401)
Solution:
Verify
POSTMAN_API_KEYis set correctlyCheck key is valid at https://postman.com/settings/me/api-keys
Ensure key has required permissions
Collection UID Format
Error: Collection not found
Solution:
Use full UID format:
12345-abc123def456Get UID from
getCollectionresponseFor createMock, pass collection UID, not bare ID
Workspace Required
Error: Workspace is required
Solution:
Call
getWorkspacesto list available workspacesPass
workspacequery parameterFor "my workspaces", call
getAuthenticatedUserfirst
Newman Integration
The runCollection tool requires Newman (Postman's CLI runner) to be integrated programmatically. This is a placeholder that returns instructions.
Requirements
Python 3.10+
Postman API Key
MCP 1.12.0+
httpx, Starlette, Uvicorn
License
MIT License - See LICENSE file for details
Support
For issues, questions, or contributions, please visit the project repository.
Additional Resources
Postman API Documentation: https://learning.postman.com/docs/developer/postman-api/intro-api/
Postman Collection Format: https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html
MCP Protocol: https://modelcontextprotocol.io
Available Tools
41 toolscreateCollectionA
Creates a collection using the Postman Collection v2.1.0 schema format. If workspace is not specified, creates in the oldest personal workspace.
| Name | Required | Description | Default |
|---|---|---|---|
| workspace | No | The workspace's ID | |
| collection | No | Collection object in Postman Collection v2.1.0 format |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must cover behavior. Discloses schema format and default workspace behavior, but lacks details on permissions, idempotency, or error handling.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single sentence that is front-loaded with purpose. No wasted words, though some may consider it too brief.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Missing return value information (no output schema) and no mention of success/error responses. For a creation tool with a nested object parameter, more context would be useful.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, but description adds key detail: workspace parameter defaults to oldest personal workspace. This goes beyond schema's 'The workspace's ID'.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States specific verb 'Creates' and resource 'collection' using Postman v2.1.0 format, distinguishing from siblings like createCollectionRequest. Default workspace behavior adds clarity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implies usage for creating collections but provides no explicit guidance on when to use this vs other creation tools like createCollectionRequest. No exclusions or alternatives mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
createCollectionRequestB
Creates a request in a collection. Recommended to pass 'name' property. See Postman Collection Format docs for full properties.
| Name | Required | Description | Default |
|---|---|---|---|
| collectionId | Yes | The collection's ID | |
| folderId | No | Folder ID (optional, creates at collection level if omitted) | |
| name | No | Request name | |
| method | No | HTTP method (GET, POST, etc.) | |
| url | No | Request URL | |
| description | No | Request description | |
| auth | No | Authentication information | |
| headerData | No | Request headers | |
| queryParams | No | Query parameters | |
| dataMode | No | Request body data mode | |
| data | No | Form data | |
| rawModeData | No | Raw mode data | |
| graphqlModeData | No | GraphQL mode data | |
| dataOptions | No | Data mode options | |
| events | No | Script events |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, and the description lacks disclosure of behavioral traits such as side effects, error handling, or auth requirements. It only states the action.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the main action. The second sentence adds a tip and reference to docs. Efficient but could incorporate more structure.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 15 parameters, no output schema, and no annotations, the description is incomplete. It does not explain return values, behavior on failure, or how the request is added to the collection.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds a recommendation for 'name' parameter, but no further semantic value beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Creates a request in a collection') and the resource, distinguishing it from siblings like createCollectionResponse.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use vs alternatives (e.g., updateCollectionRequest) or when not to use. The recommendation to pass 'name' is minimal and not contextual.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
createCollectionResponseC
Creates a request response in a collection. Recommended to pass 'name' property. See Response entry in Postman Collection Format docs.
| Name | Required | Description | Default |
|---|---|---|---|
| collectionId | Yes | Collection ID | |
| request | Yes | Parent request ID | |
| name | No | Response name | |
| description | No | Response description | |
| status | No | HTTP status text | |
| responseCode | No | HTTP response code info | |
| headers | No | Response headers | |
| cookies | No | Cookie data | |
| text | No | Raw response body text | |
| language | No | Language type | |
| mime | No | MIME type | |
| time | No | Time taken (ms) | |
| method | No | Request HTTP method | |
| url | No | Request URL | |
| dataMode | No | Request body data mode | |
| dataOptions | No | Data mode options | |
| rawModeData | No | Raw mode data | |
| rawDataType | No | Raw data type | |
| requestObject | No | JSON-stringified request representation |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are present, so the description must disclose all behavioral traits. It only mentions the action and a recommendation to pass 'name', but no information on side effects, permissions, error states, or outcome (e.g., whether it overwrites or creates new).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no redundant information. It is front-loaded with the purpose and includes a recommendation. Could be slightly improved by structuring, but acceptable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has 19 parameters and no output schema, the description is too terse. It does not explain how parameters relate, the expected behavior of nested objects, or what the response is. The reference to external docs partially compensates but falls short for an agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents each parameter. The description adds a useful recommendation about 'name', which is minor extra context. Thus baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states it creates a request response in a collection. However, it does not differentiate from siblings like createCollectionRequest or updateCollectionRequest, which also deal with request-related objects.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives, nor any prerequisites or conditions. The description lacks context for proper selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
createEnvironmentB
Creates an environment. Max size 30MB. If workspace not specified, creates in oldest personal workspace.
| Name | Required | Description | Default |
|---|---|---|---|
| workspace | No | Workspace ID | |
| environment | No | Environment object with name and values |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses size limit (30MB) and default workspace behavior, which adds value beyond the input schema. However, with no annotations, it's missing information on mutation effects, permissions, or reversibility. Adequate but not comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no fluff. The most important info (creation, size, default) is front-loaded. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a creation tool with no output schema, the description covers key constraints but omits what the tool returns (e.g., created environment ID or object). The complexity is moderate, so a bit more detail would improve completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds useful extra context: 'Max size 30MB' constrains the environment object, and the workspace default clarifies behavior. This helps the agent understand parameter implications beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states 'Creates an environment' with specific details (max size 30MB, workspace default). Distinguishes from sibling tools like createCollection or createWorkspace by focusing on environment creation, though no explicit differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool vs alternatives (e.g., putEnvironment for updates, or when to specify workspace). The description hints at default behavior but doesn't provide context for decision-making.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
createMockA
Creates a mock server for a collection. Use collection UID (ownerId-collectionId). Use workspace param to specify target workspace.
| Name | Required | Description | Default |
|---|---|---|---|
| workspace | No | Workspace ID | |
| mock | No | Mock server configuration with collection UID, name, and settings |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It discloses the UID format and workspace requirement, but lacks details on permissions, side effects, success/failure outcomes, or whether the collection must exist. The nested object's internal structure is partially described but could be more explicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences: the first states the primary action clearly, and the second provides key parameter guidance. No unnecessary words, fully front-loaded, and efficient for an AI agent.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool creates a mock server with a nested object parameter and no output schema. The description covers the input format and workspace, but does not explain what happens after creation (e.g., return value, how to access the mock) or provide expected behavior. Adequate but incomplete for a creation tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the description adds only modest value by specifying the collection UID format (ownerId-collectionId). The workspace param description is essentially restated. Overall, it supplements rather than significantly extends the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Creates' and the resource 'mock server for a collection', and distinguishes it from sibling tools like updateMock and publishMock by focusing on creation. It also specifies the unique identifier format (collection UID as ownerId-collectionId), adding precision.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage by stating to use workspace param and collection UID, but does not explicitly contrast with alternatives like createCollection or updateMock. No when-to-use or when-not-to-use guidance is provided, leaving the agent to infer context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
createSpecA
Creates an API spec in Postman's Spec Hub. Supports OpenAPI 2.0/3.0/3.1, AsyncAPI 2.0, protobuf 2/3, GraphQL. Max file size 10MB.
| Name | Required | Description | Default |
|---|---|---|---|
| files | Yes | List of spec files with path and content. Use '/' in path to create folders. | |
| name | Yes | Specification name | |
| type | Yes | Spec type (openapi, asyncapi, proto, graphql) | |
| workspaceId | Yes | Workspace ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the behavioral burden. It discloses supported API specification formats (OpenAPI, AsyncAPI, etc.) and the maximum file size of 10MB, which are critical behavioral constraints not in the schema. However, it does not mention side effects, auth requirements, or expected responses.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence containing all key information: action, supported formats, and constraint. No filler or redundancy. It is front-loaded with the primary action and efficiently conveys the essential details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is relatively complex (multiple formats, file handling, size limit) and lacks an output schema. The description covers input constraints well but omits return value details (e.g., does it return the created spec ID?). For a creation tool, this omission limits completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 100% schema coverage, the baseline is 3. The description adds value beyond schema by clarifying the file path convention ('Use '/' in path to create folders') and implicitly linking the 'type' parameter to the listed formats. This extra guidance improves parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description begins with 'Creates an API spec in Postman's Spec Hub,' clearly stating the verb and resource. It also lists supported formats and a file size limit, further specifying the tool's function and distinguishing it from siblings like 'createSpecFile' or 'getSpec'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when creating a spec, but does not explicit when to use this tool over alternatives like 'createSpecFile'. Given the sibling tools include file-level creation, the absence of comparative guidance leaves the agent to infer usage from context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
createSpecFileA
Creates an API spec file. Use '/' in path to create folders. File assigned DEFAULT type. Max size 10MB.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID | |
| content | Yes | File's stringified contents | |
| path | Yes | File path (JSON or YAML) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description must disclose behavior. It mentions file assignment of DEFAULT type and a 10MB size limit, but omits details like whether files are overwritten, if path must be unique, or success/error behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three concise sentences, each adding distinct information, with no wasted words. Front-loaded with the core action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers basic purpose and constraints, but missing return values, error handling, and relationship to sibling tools like createSpec. Adequate but not comprehensive for a creation tool with no output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Despite 100% schema coverage, the description adds value by explaining the path parameter's folder creation using '/' and noting the DEFAULT type and size limit, which are not in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it creates an API spec file, specifies use of '/' for folder creation, and distinguishes from siblings like createSpec which likely creates a spec container. The verb and resource are specific.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like createSpec, createCollection, etc. No prerequisites or context for choosing this tool are mentioned, leaving ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
createWorkspaceA
Creates a new workspace. Private/Partner workspaces require Team/Enterprise. Public names must be unique. Pass teamId if Organizations is enabled.
| Name | Required | Description | Default |
|---|---|---|---|
| workspace | No | Workspace object with name, type, description |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description mentions the creation behavior and important constraints, but lacks details on what the tool returns (e.g., workspace ID) and error handling. Since no annotations are provided, the description carries the burden, but it is partially adequate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences long, front-loaded with the main purpose, and every sentence adds value without any unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers creation purpose and key constraints, but lacks information about required fields (is name required?), success output, and error scenarios. Given the nested object parameter and no output schema, it is adequate but not complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema covers the workspace parameter with a description. The tool's description adds context about type constraints and the optional teamId field, but the teamId is not in the schema, causing slight inconsistency. Overall, it adds some meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Creates a new workspace', using a specific verb and resource. It distinguishes itself from sibling tools like updateWorkspace and getWorkspaces, as it is the only creation tool for workspaces.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context for when to use the tool by specifying constraints: Private/Partner workspaces require Team/Enterprise, public names must be unique, and teamId should be passed if Organizations is enabled. It does not explicitly state when not to use it, but that is implied by the existence of updateWorkspace.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
duplicateCollectionB
Duplicates a collection to another workspace. Returns a task ID - use getDuplicateCollectionTaskStatus to check status.
| Name | Required | Description | Default |
|---|---|---|---|
| collectionId | Yes | The collection's unique ID | |
| workspace | Yes | Target workspace ID | |
| suffix | No | Optional suffix for duplicated collection name |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must fully disclose behavioral traits. It indicates the operation is asynchronous (returns a task ID) but does not mention whether the original collection remains, potential destructive behavior, or permission requirements.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, consisting of two short sentences. The main action is front-loaded, and every word serves a purpose. No unnecessary details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 3 parameters, no output schema, and no annotations, the description is adequate but not complete. It covers the basic purpose and asynchronous nature but omits behavioral details like whether the operation is copy (not move) and error conditions.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds no additional meaning beyond the schema's parameter descriptions, which already clearly define collectionId, workspace, and suffix.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action (duplicates), the resource (collection), and the target (another workspace). It also specifies the return type (task ID) and cross-references a sibling tool for status checking. This distinguishes it from other collection-related tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not provide any guidance on when to use this tool versus alternatives like createCollection or putCollection. It mentions the status tool but lacks context on prerequisites, scenarios, or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generateCollectionA
Creates a collection from an API spec. Returns polling link to task status.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID | |
| name | Yes | Generated collection name | |
| elementType | Yes | Collection element type | |
| options | No | Advanced creation options (see OpenAPI to Postman Converter docs) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses the asynchronous nature via 'Returns polling link', which is beyond basic mutation. However, it omits auth needs or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the action, no wasted words. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given siblings and a nested options parameter, the description covers the polling link but lacks differentiation from siblings and explanation of the options parameter. Adequate but not comprehensive.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3. The description adds no extra meaning beyond the schema; it contextualizes the purpose but doesn't enhance parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Creates a collection from an API spec') and distinguishes from siblings like createCollection by specifying the source. It also adds a key behavioral trait: returns a polling link.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for generating from an API spec, which differentiates from createCollection, but lacks explicit when-to-use or alternatives. No exclusions are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generateSpecFromCollectionB
Generates an API spec for a collection. Returns polling link to task status.
| Name | Required | Description | Default |
|---|---|---|---|
| collectionUid | Yes | Collection unique ID | |
| name | Yes | API spec name | |
| elementType | Yes | The 'spec' value | |
| format | Yes | Format (openapi, asyncapi, etc.) | |
| type | Yes | Specification type |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Mentions 'Returns polling link to task status' which indicates asynchronous behavior, a key trait beyond schema. However, no annotations exist, and the description does not disclose other aspects like permissions or whether it's idempotent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the core action. No unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is relatively complex (5 required params, no output schema, async with polling link) but the description is minimal. It doesn't explain how to interpret the polling link, the format of the generated spec, or what happens if the collection doesn't exist. Leaves gaps for an agent to infer.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds no extra meaning beyond the parameter descriptions already in the schema. All parameters are briefly described in schema, and description does not elaborate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Generates an API spec') and the resource ('collection'). This distinguishes it from siblings like createSpec (creates spec from scratch) and syncCollectionWithSpec (syncs existing).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this vs alternatives like createSpec or syncCollectionWithSpec. Missing context about prerequisites or when to prefer this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAllSpecsC
Gets all API specifications in a workspace.
| Name | Required | Description | Default |
|---|---|---|---|
| workspaceId | Yes | Workspace ID | |
| cursor | No | Pagination cursor (nextCursor from previous response) | |
| limit | No | Max rows to return |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description bears full responsibility. It only states 'gets all' without disclosing pagination behavior (despite cursor/limit parameters), error handling, ordering, or scope beyond basic listing.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single concise sentence that earns its place by stating the core action. It is not verbose, but could be slightly expanded with edge cases.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema and no annotations, the description fails to mention that results are paginated, what fields are returned, or that the 'all' is limited by pagination. Essential context is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with each parameter having a description. The tool description does not add meaning beyond the schema, which is adequate given the coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Gets all API specifications in a workspace' with a specific verb and resource. It distinguishes from sibling tools like getSpec (singular) and getSpecCollections, though not explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives like getSpec or getSpecCollections. No exclusions or prerequisites mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAuthenticatedUserA
Gets information about the authenticated user. Use this to get current user context (user.id, username, teamId, roles) for 'my ...' requests.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description does not mention behavioral traits such as read-only nature, authentication requirements, or potential errors. This leaves the agent without critical safety information.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences with no wasted words. The first sentence states the primary purpose, and the second provides usage context, making it efficient for an agent to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simple nature of the tool (no parameters, no output schema), the description adequately covers the primary usage and return fields. However, it omits error conditions or authentication context, which are mildly important for completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has zero parameters (100% coverage), so no additional parameter details are needed. The description adds value by listing the returned fields (user.id, username, teamId, roles), which aids in understanding the output.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Gets' and the resource 'information about the authenticated user', distinguishing it from sibling tools that fetch other resources like workspaces or collections.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly advises using this tool for 'my ...' requests, providing clear context. It does not explicitly exclude other scenarios, but the guidance is sufficient for an agent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCollectionA
Get information about a collection. Returns lightweight collection map by default. Use model='minimal' for root-level IDs only, or model='full' for complete payload.
| Name | Required | Description | Default |
|---|---|---|---|
| collectionId | Yes | The collection ID in format <OWNER_ID>-<COLLECTION_ID> | |
| access_key | No | Collection's read-only access key (optional, doesn't require API key) | |
| model | No | Response model: 'minimal' for root-level IDs, 'full' for complete payload |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description carries full burden. It reveals the default response (lightweight map) and model options, but lacks details on error handling or authentication requirements (though access_key is noted).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two efficient sentences, front-loaded with the primary purpose. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple retrieval tool without output schema, the description adequately covers behavior and parameter options. Could mention potential errors or required permissions for completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema already describes all parameters (100% coverage). The description adds context for the 'model' parameter, clarifying 'root-level IDs' vs 'complete payload', which goes beyond the enum values.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it retrieves collection information, distinguishing it from sibling tools like getCollections (plural) and createCollection. It specifies the default return type and available response models.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explains when to use different 'model' values (minimal, full) but could explicitly contrast this tool with alternatives (e.g., getCollections for listing).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCollectionsA
Gets all collections in a workspace. Workspace ID is required - ask user if not provided.
| Name | Required | Description | Default |
|---|---|---|---|
| workspace | Yes | The workspace's ID (required) | |
| limit | No | Maximum number of rows to return | |
| name | No | Filter by collections matching this name | |
| offset | No | Zero-based offset for pagination |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden for behavioral disclosure. It implies a read-only operation but does not explicitly confirm safety, side effects, or behavior like pagination or filtering details. This is a significant gap for a tool with no annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, with the purpose front-loaded in the first sentence and usage guidance in the second. Every word earns its place, and there is no redundancy or fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a listing tool with 4 parameters and no output schema, the description covers the core purpose and a key usage point. However, it omits details about pagination, filtering behavior beyond 'name', or return format, leaving some gaps for an agent to infer.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description does not add new meaning beyond the schema; it only repeats the requirement for workspace ID, which is already in the required field. No additional semantic value for parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Gets all collections in a workspace,' which specifies the verb (gets), resource (collections), and scope (in a workspace). This distinguishes it from sibling tools like getCollection (singular) and createCollection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states that the workspace ID is required and advises to 'ask user if not provided,' providing clear guidance on the prerequisite. However, it does not mention when to avoid using this tool or suggest alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDuplicateCollectionTaskStatusC
Gets the status of a collection duplication task.
| Name | Required | Description | Default |
|---|---|---|---|
| taskId | Yes | The task's unique ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description does not disclose behavioral traits such as being a read operation, possible error states, or rate limits. It fails to add value beyond the name.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single clear sentence, front-loaded with the purpose. It is appropriately sized, though could be slightly more informative.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has no output schema, so the description should explain the return value or status format. It does not. Given the many sibling tools, more context would be helpful (e.g., used after duplicateCollection).
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The parameter taskId is fully described in the schema as 'The task's unique ID', so the description adds no additional meaning. Schema coverage is 100%, so baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that it gets the status of a collection duplication task, using a specific verb and resource. It distinguishes itself from siblings like duplicateCollection or getCollection, but does not explicitly differentiate.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool (e.g., after calling duplicateCollection) or alternatives. No mention of prerequisites or context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getEnabledToolsA
IMPORTANT: Run this first when a requested tool is unavailable. Returns info about enabled tools in full and minimal sets.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the burden. It implies a read operation but does not explicitly state it is side-effect free or disclose any other behavioral aspects. For a simple informational tool, this is adequate but could be more explicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with 'IMPORTANT', no wasted words. The key message is immediate and clear.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no parameters and no output schema, the description covers the essential purpose and usage context. It mentions 'full and minimal sets' for output, which is sufficient for an agent to understand what to expect, though more detail on the output format could be added.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There are no parameters (schema coverage 100%), so the schema does all the work. The description adds value by mentioning 'full and minimal sets', hinting at the output structure beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns info about enabled tools and should be run first when a requested tool is unavailable. The verb 'return' and resource 'enabled tools' are specific, and it distinguishes from sibling tools that deal with specific resources like collections or environments.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly instructs the agent to run this tool first when a requested tool is unavailable, providing clear when-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getEnvironmentC
Gets information about an environment.
| Name | Required | Description | Default |
|---|---|---|---|
| environmentId | Yes | Environment ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of disclosing behavioral traits. It only states 'Gets information' without mentioning read-only nature, side effects, or potential errors, which is insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, but it is arguably underspecified rather than appropriately concise. It could provide more value without losing brevity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema is provided, and the description does not explain return values or behavior. For a low-complexity tool with one parameter, the description is still incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the parameter 'environmentId' is already documented in the input schema. The description does not add any additional meaning or context beyond that.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Gets information about an environment,' using a specific verb and resource. However, it does not differentiate from the sibling tool 'getEnvironments,' which retrieves multiple environments, leading to some ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'getEnvironments' or 'putEnvironment.' There are no exclusions or context mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getEnvironmentsB
Gets all environments. Optionally filter by workspace.
| Name | Required | Description | Default |
|---|---|---|---|
| workspace | No | Workspace ID (optional) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description must fully disclose behaviors. It indicates a read operation but does not mention return format, pagination, or potential error states. This is minimal transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Extremely concise: two short sentences with no redundant information. Every word serves a purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple retrieval tool with one optional parameter, the description is adequate but not fully complete. It omits any mention of return type or scope, which would be helpful given no output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% for the single parameter. The description restates the filter functionality without adding new semantic meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Gets' and the resource 'environments', with an optional filter by workspace. It distinguishes itself from sibling 'getEnvironment' which retrieves a single environment.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives like 'getEnvironment' or 'getWorkspaces'. The description does not specify any prerequisites or context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getGeneratedCollectionSpecsC
Gets the API spec generated for a collection.
| Name | Required | Description | Default |
|---|---|---|---|
| collectionUid | Yes | Collection unique ID | |
| elementType | Yes | The 'spec' value |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden for behavioral disclosure, but it only states 'Gets the API spec generated for a collection.' It does not mention whether the operation is read-only, what side effects exist, or any other behavioral traits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no redundant information. It is appropriately sized for a simple get operation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the absence of an output schema and the presence of many sibling tools, the description is too minimal. It does not explain the returned data format or how this tool differs from similar ones like 'getSpec' or 'getSpecCollections.'
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and both parameters (collectionUid, elementType) have descriptions. The tool description adds no additional meaning beyond the schema, so a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Gets the API spec generated for a collection,' which identifies the verb and resource. However, it does not explicitly differentiate from sibling tools like 'getSpec' or 'getSpecCollections,' which could lead to confusion in selection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives. The description lacks context about prerequisites, exclusions, or typical use cases, leaving the agent without decision support.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getMockB
Gets information about a mock server, including associated collection UID and mockUrl.
| Name | Required | Description | Default |
|---|---|---|---|
| mockId | Yes | Mock server ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description does not disclose behavioral traits beyond stating it 'gets information'. With no annotations, it fails to mention that this is a read-only operation, any required permissions, or potential side effects. It only hints at the response content without full transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence of 12 words, directly stating the tool's purpose. It is concise and front-loaded, with no unnecessary information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simple tool with one parameter and no output schema, the description is adequate but not fully complete. It mentions two specific pieces of information returned (collection UID and mockUrl) but does not confirm the full response structure or potential errors. It meets the minimum viable standard.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already describes the 'mockId' parameter as 'Mock server ID'. The description adds no additional meaning or context about the parameter, such as its format or where to find it. Since schema coverage is 100%, the description does not need to compensate, but it also does not enhance parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that the tool retrieves information about a mock server, specifically mentioning the collection UID and mockUrl. This distinguishes it from sibling tools like 'getMocks' (which likely lists mocks) and 'createMock' (which creates a mock).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives such as 'getMocks' for listing or 'publishMock' for publishing. There is no mention of context, prerequisites, or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getMocksA
Gets all active mock servers. Always pass workspace or teamId. Prefer workspace when known. Set teamId from GET /me (me.teamId) for team scope.
| Name | Required | Description | Default |
|---|---|---|---|
| teamId | No | Team ID (from GET /me: me.teamId) | |
| workspace | No | Workspace ID (preferred) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It only states it gets all active mock servers, but does not disclose whether there are side effects, rate limits, pagination, or the exact set of fields returned. Lacks behavioral depth.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with purpose. No extraneous information. Efficient and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema exists, yet the description does not describe the response structure or any other contextual details (e.g., pagination, sorting). Combined with absent annotations, the tool is under-documented for practical use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, baseline 3. The description adds value by instructing on parameter preference (workspace over teamId) and how to derive teamId, beyond the schema's brief descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool gets all active mock servers. It uses specific verb (Gets) and resource (active mock servers), and is distinguishable from siblings like getMock (single), createMock, etc.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides clear guidance on when to pass workspace vs teamId, preferring workspace when known and instructing how to obtain teamId from GET /me. Does not explicitly state when not to use this tool or list alternatives, but the context is sufficient.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getSpecC
Gets information about an API specification.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description does not disclose any behavioral traits beyond the input schema. Without annotations, the agent lacks information about side effects, permissions, or what 'information' is returned, which is insufficient for a read operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no redundant information. It is appropriately concise for a simple getter tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of an output schema and the presence of many sibling tools, the description should provide more context about what 'information' is returned. It does not, leaving the agent underinformed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% coverage with a description 'Spec ID' for the single parameter. The description adds no additional meaning beyond the schema, so a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Gets information about an API specification,' using a specific verb and resource. However, it does not distinguish 'getSpec' from sibling tools like 'getSpecDefinition' or 'getSpecFiles', which could cause confusion.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives. Given the many sibling tools with similar names (e.g., 'getAllSpecs', 'getSpecDefinition'), explicit usage context is missing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getSpecCollectionsB
Gets all collections generated from an API spec.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID | |
| elementType | Yes | Collection element type | |
| cursor | No | Pagination cursor | |
| limit | No | Max rows |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, and the description does not disclose behavioral traits like pagination (cursor/limit), error handling, or side effects. The input schema implies pagination but description does not explain behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One-sentence description is concise but lacks necessary detail for a tool with 4 parameters. Not overly verbose, but could be more informative without being longer.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema and minimal description. Missing details on pagination behavior, return format, meaning of elementType, and what 'collections generated from an API spec' entails. Inadequate for making informed invocation decisions.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% (all 4 parameters have descriptions). The tool description adds no additional meaning beyond the schema; e.g., does not explain how cursor/limit affect pagination or what elementType values are valid. Baseline 3 due to high coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Gets all collections generated from an API spec' clearly states the verb 'Gets' and resource 'collections', specifying the source 'from an API spec'. This distinguishes it from siblings like getCollections (all collections) and createCollection (creation).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives such as getCollections or getTaggedEntities. Absence of context on prerequisites, exclusions, or use cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getSpecDefinitionB
Gets the complete contents of an API spec's definition.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description should disclose behavioral traits (e.g., return size, permissions), but it only states it 'gets' contents, lacking depth.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One concise sentence with no waste, but lacks additional structured information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple retrieval tool with one required parameter and no output schema, the description is mostly complete, though could note what 'complete contents' entails.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with parameter specId already described, so the description adds no extra meaning; baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Gets' and the resource 'complete contents of an API spec's definition', which is specific and distinct from sibling tools like 'getSpec' or 'getSpecFile'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives, nor any exclusions or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getSpecFileB
Gets the contents of an API spec's file.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID | |
| filePath | Yes | Path to the file |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description does not disclose behavioral traits such as read-only nature, side effects, or authentication requirements. The agent must infer safety from the name alone.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no fluff. Every word is necessary.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema is provided, and the description does not explain the return format (e.g., raw text, JSON, binary). For a tool that retrieves file contents, this gap reduces completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, with clear parameter descriptions (specId, filePath). The description adds no additional meaning beyond the schema, earning a baseline 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Gets' and the resource 'contents of an API spec's file,' which distinguishes it from siblings like getSpec (gets spec metadata) and getSpecFiles (lists files).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives such as getSpec or getSpecFiles. An AI agent has no context for selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getSpecFilesC
Gets all files in an API specification.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description does not disclose any behavioral traits beyond a generic read operation. No mention of side effects, authorization requirements, or safety (e.g., read-only). With no annotations, the description fails to convey essential behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise (one sentence) and front-loaded, but it is too brief to be informative. It sacrifices completeness for brevity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with one required parameter and no output schema, the description is insufficient. It does not clarify what 'all files' includes (names, contents, metadata?) or how the tool relates to similar tools like getSpecFile.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds no meaning beyond the schema's 'Spec ID' description. It does not explain what 'files' are, what format specId expects, or how results are scoped.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Gets') and the resource ('all files in an API specification'), but does not explicitly distinguish from sibling tools like getSpecFile (singular) or getSpec.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool vs alternatives such as getSpecFile, getSpec, or other specification-related tools. The agent receives no context for decision-making.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTaggedEntitiesB
Gets Postman entities by tag. Enterprise only - returns 404 on Free/Basic/Professional plans.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Tag ID | |
| cursor | No | Pagination cursor | |
| direction | No | Sort order | |
| entityType | No | Filter by entity type | |
| limit | No | Max entities to return |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must disclose behaviors. It only states the read operation and a specific error condition. It does not describe pagination behavior (despite cursor and limit parameters), sorting, filtering effects, or any side effects. Minimal transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no redundancy. The purpose is front-loaded, and the Enterprise constraint is stated immediately. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 5 parameters, no output schema, and no annotations, the description is insufficient. It fails to explain that results are paginated, what entity types are included, or how to use cursor for pagination. Sibling tools suggest entity-specific retrievers, yet this tool's cross-entity nature is not clarified.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, so the schema already documents each parameter. The description adds no additional meaning or context for parameters like slug, cursor, direction, entityType, or limit. Baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Gets' and the resource 'Postman entities by tag'. It also mentions the Enterprise-only limitation, which differentiates it from other get tools. However, 'Postman entities' is somewhat vague, lacking specificity about which entity types are returned.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description indicates when NOT to use the tool (non-Enterprise plans) due to 404 error. It does not provide guidance on when to use this tool versus sibling tools like getCollection or getSpec, which return specific entity types. Implied usage but lacks explicit alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkspaceB
Gets information about a workspace (visibility: personal/team/private/public/partner).
| Name | Required | Description | Default |
|---|---|---|---|
| workspaceId | Yes | Workspace ID | |
| include | No | Include 'mocks:deactivated' or 'scim' data |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Absent annotations, the description provides minimal behavioral insight. It implies a read operation but does not explicitly state read-only nature, required permissions, or side effects. No mention of return value structure or limitations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single, front-loaded sentence with no extraneous content. Every word adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Low complexity but no output schema. The description fails to specify what 'information' is returned, which is critical for agent decision-making. Without output schema, the description should outline key return fields.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers 100% of parameters with descriptions, so baseline 3. The description adds conceptual context (visibility types) but does not enhance parameter understanding beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Gets information') and the resource ('a workspace'), with additional context about visibility types. It distinctly differs from sibling 'getWorkspaces' by focusing on a single workspace.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives like 'getWorkspaces' or other retrieval tools. The description lacks usage context, exclusions, or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkspacesA
Gets all accessible workspaces. For 'my ...' requests, call GET /me first and pass createdBy={me.user.id}. Paginated with cursor.
| Name | Required | Description | Default |
|---|---|---|---|
| createdBy | No | User ID (from GET /me: me.user.id) for 'my ...' requests | |
| type | No | Workspace type filter | |
| cursor | No | Pagination cursor (meta.nextCursor from previous response) | |
| elementId | No | Filter by element ID (requires elementType) | |
| elementType | No | Element type (requires elementId) | |
| include | No | Include 'mocks:deactivated' or 'scim' | |
| limit | No | Max rows (default 100) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. Indicates read-only retrieval and pagination, but does not explicitly state safety, authentication, or error behavior. Adequate for a simple list tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences. First sentence states purpose immediately. No redundant words or fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers main purpose, pagination, and a specific use case. Lacks return structure details, but without output schema, this is acceptable for a list tool with well-described parameters.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema provides 100% parameter descriptions. The description adds meaningful context for createdBy (needs GET /me) and pagination (cursor/limit), enhancing understanding beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states verb 'Gets' and resource 'accessible workspaces'. Distinguishes from siblings like getWorkspace (singular) and createWorkspace by implying a list operation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides clear context for 'my ...' requests with a specific recipe. Mentions pagination with cursor, hinting at iterative usage. Does not explicitly contrast with alternatives like getWorkspace.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
publishMockA
Publishes a mock server (sets Access Control to public).
| Name | Required | Description | Default |
|---|---|---|---|
| mockId | Yes | Mock server ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It discloses that the tool changes Access Control to public, which is a behavioral trait. However, it lacks details on reversibility, permissions needed, or side effects, making it only partially transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence with no redundant words. It is front-loaded and efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple tool with one parameter and no output schema, the description covers the core action and its effect. It could mention the result or whether the operation is permanent, but overall it is reasonably complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with one parameter (mockId) described as 'Mock server ID'. The description adds no semantic value beyond the schema. Baseline 3 is appropriate since the schema is sufficient.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'publishes' and the resource 'mock server', with a specific effect 'sets Access Control to public'. It distinguishes from sibling tools like createMock (creation) and updateMock (update).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the tool is used to make a mock server public, but it does not provide explicit guidance on when to use it versus alternatives (e.g., updateMock) or any prerequisites. Usage context is weakly inferred.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
putCollectionA
Replaces collection contents using Postman Collection v2.1.0 format. Include ID values or they'll be removed and recreated. Max size 100MB.
| Name | Required | Description | Default |
|---|---|---|---|
| collectionId | Yes | Collection ID in format <OWNER_ID>-<COLLECTION_ID> | |
| Prefer | No | Use 'respond-async' for async update (returns 202) | |
| collection | No | Collection object in Postman Collection v2.1.0 format |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses that operation replaces contents, requires ID preservation to avoid recreation, and has 100MB size limit. No annotations to contradict; description carries burden well.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two succinct sentences conveying essence upfront. Every word contributes: action, format, ID warning, size limit.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers key behavioral aspects for a replacement operation with three parameters and no output schema. Sufficient for an agent to use correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers 100% of parameters with basic descriptions; adds value with ID warning and size constraint, enhancing understanding beyond schema fields.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states 'Replaces collection contents' with specific format and size constraint, distinguishing it from siblings like createCollection or getCollection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides important usage warning about ID values but does not explicitly state when to use vs. alternatives (e.g., putCollection vs. updateCollectionRequest). Implies usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
putEnvironmentA
Replaces all environment contents. Max size 30MB.
| Name | Required | Description | Default |
|---|---|---|---|
| environmentId | Yes | Environment ID | |
| environment | No | Environment object with name and values |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries burden. It discloses the destructive nature (replaces all) and a key constraint (max 30MB). Does not cover permissions, error handling, or side effects, but the given info is valuable.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with the main action. No redundant information. Every word is necessary.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema, so return value is undefined. Description does not mention success/failure, side effects, or prerequisites. While the core action is clear, additional context about behavior would improve completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with descriptions for both parameters. Description adds the size limit but does not elaborate on the environment object structure beyond schema. Baseline 3 with some additional value from size constraint.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Replaces all environment contents' clearly states the action (replaces), resource (environment), and scope (all contents). The size constraint adds specificity. Sibling tools include createEnvironment, so the description distinguishes this as an overwrite operation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit guidance on when to use vs alternatives like createEnvironment or partial updates. The phrase 'replaces all' implies full overwrite, but no usage or exclusion cases are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
runCollectionB
Runs a Postman collection with detailed test results and execution statistics. Supports optional environment for variable substitution.
| Name | Required | Description | Default |
|---|---|---|---|
| collectionId | Yes | Collection ID in format <OWNER_ID>-<COLLECTION_ID> | |
| environmentId | No | Optional environment ID for variable substitution | |
| iterationCount | No | Number of iterations (default: 1) | |
| requestTimeout | No | Request timeout in ms (default: 60000) | |
| scriptTimeout | No | Script timeout in ms (default: 5000) | |
| abortOnError | No | Abruptly halt on errors (default: false) | |
| abortOnFailure | No | Abruptly halt on test failures (default: false) | |
| stopOnError | No | Gracefully halt on errors (default: false) | |
| stopOnFailure | No | Gracefully halt on test failures (default: false) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It states it runs a collection and returns test results, but does not disclose potential side effects (e.g., making HTTP requests), authentication needs, or resource implications. This lack of disclosure reduces transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no wasted words. Front-loaded with the main purpose and supplementary detail. Efficiently communicates essential information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 9 parameters and no output schema, the description is too sparse. It does not explain the return format ('detailed test results, execution statistics'), nor the behavior of timeout or abort options. A more complete description would tie parameters together and clarify expected outcomes.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3. The description adds minimal value beyond the schema, only noting optional environment for variable substitution, which is already described in the schema. No additional context for other parameters like iterationCount or abortOnError.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool runs a Postman collection and provides detailed test results and execution statistics. It uses a specific verb ('Runs') and resource ('Postman collection'), and distinguishes from siblings like getCollection or putCollection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not provide guidance on when to use this tool versus alternatives (e.g., getCollection for retrieval). It only mentions optional environment support, but no when-not-to-use or context for choosing this over siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
syncCollectionWithSpecA
Syncs a collection generated from an API spec. Async endpoint returns 202. Only for OpenAPI 2.0/3.0/3.1.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID | |
| collectionUid | Yes | Collection unique ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the burden. It discloses the async nature (returns 202) but does not mention whether the operation is destructive, required permissions, or error conditions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no fluff, front-loaded with key information. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, two required params, and the description covers the async behavior and version constraints. However, it could mention what the response body contains beyond status 202.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% coverage with basic descriptions ('Spec ID', 'Collection unique ID'). The description adds no additional meaning to the parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Syncs a collection generated from an API spec'), specifies the async nature and return status, and limits to specific API spec formats. This distinguishes it from siblings like syncSpecWithCollection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It specifies the tool is only for OpenAPI 2.0/3.0/3.1, providing clear when-to-use guidance. It does not explicitly state when not to use or mention alternatives, but the constraint is strong.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
syncSpecWithCollectionB
Syncs an API spec linked to a collection. Async endpoint returns 202. Only for OpenAPI 2.0/3.0/3.1.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID | |
| collectionUid | Yes | Collection unique ID |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full responsibility for behavioral disclosure. It notes that the endpoint is async and returns 202, and is only for OpenAPI 2.0/3.0/3.1. However, it omits critical details such as whether the operation is destructive, what prerequisites are needed (e.g., spec must be linked), and what happens on failure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is exceptionally concise, with two short sentences. The first sentence states the core purpose, and the second adds critical behavioral context. No unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the essential purpose and two key constraints (async, version limits), but lacks details on prerequisites, synchronization direction, and response format. Given no output schema, a bit more context would improve completeness, but it is minimally adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides descriptions for both parameters (100% coverage), so the baseline is 3. The tool description adds no additional semantic meaning to the parameters beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Syncs') and the resource ('API spec linked to a collection'), making the purpose evident. However, it does not explicitly differentiate from the sibling 'syncCollectionWithSpec', leaving the direction of synchronization ambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides some context (async endpoint, OpenAPI version constraint) but lacks guidance on when to use this tool versus alternatives like 'syncCollectionWithSpec' or 'generateSpecFromCollection'. No exclusions or when-not-to-use criteria are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
updateCollectionRequestA
Updates a request in a collection (PATCH-like: only updates provided fields). Cannot change folder. Use collection ID (not UID).
| Name | Required | Description | Default |
|---|---|---|---|
| collectionId | Yes | Collection ID (not UID) | |
| requestId | Yes | Request ID | |
| name | No | Request name | |
| method | No | HTTP method | |
| url | No | Request URL | |
| description | No | Request description | |
| auth | No | Authentication info | |
| headerData | No | Headers | |
| queryParams | No | Query parameters | |
| dataMode | No | Body data mode | |
| data | No | Form data | |
| rawModeData | No | Raw mode data | |
| graphqlModeData | No | GraphQL mode data | |
| dataOptions | No | Data options | |
| events | No | Script events |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It explains the partial update behavior and folder constraint, but omits details like authorization needs, response format, or side effects. Adequate but not comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no redundant information. First sentence introduces purpose and behavior, second adds constraints. Front-loaded and efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 15 parameters and no output schema or annotations, the description is too brief. It lacks information about return values, error conditions, permissions, and parameter interactions. Does not fully compensate for missing structured metadata.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, baseline is 3. Description adds value by clarifying the PATCH-like semantics (only provided fields updated) and emphasizing the use of collection ID over UID, going beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool updates a request in a collection with a PATCH-like behavior, and specifies a constraint (cannot change folder) and ID usage (collection ID not UID). This distinguishes it from createCollectionRequest and putCollection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Description implies partial updates (PATCH-like) and notes a limitation (cannot change folder), but does not explicitly compare with alternatives like putCollection or createCollectionRequest. The guidance is present but not exhaustive.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
updateMockA
Updates a mock server (name, environment, privacy, default response).
| Name | Required | Description | Default |
|---|---|---|---|
| mockId | Yes | Mock server ID | |
| mock | No | Mock server updates |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description must disclose behavioral traits. It only says 'updates', implying mutation, but lacks details like permissions required, idempotency, side effects, or whether partial updates are supported.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single sentence that is direct and contains no redundant information. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema and a nested object parameter, the description could be more complete. It does not mention return value or confirm successful update. However, it covers the core update functionality adequately for a minimum viable description.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% (both parameters described), so baseline is 3. The description adds value by listing updatable fields (name, environment, privacy, default response) within the mock object, though it doesn't fully describe the nested structure.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Updates' and the resource 'mock server', listing specific fields (name, environment, privacy, default response). It distinguishes from sibling tools like createMock, publishMock, and getMock.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool vs alternatives. With many sibling tools (e.g., createMock, publishMock), the description should provide context such as prerequisites or when to update vs create.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
updateSpecFileA
Updates an API spec's file. Only pass one property at a time (content, name, or type). Max size 10MB.
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID | |
| filePath | Yes | Path to the file | |
| content | No | Stringified contents | |
| name | No | File name | |
| type | No | ROOT (entry point) or DEFAULT (referenced file) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It states the mutation action and a size limit, but lacks details on error behavior, response format, or whether the update is partial or full. This is adequate but leaves gaps.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise: two sentences without any redundant information. Every word contributes to clarity and constraints.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of annotations and output schema, the description provides key constraints (one property, size limit) but does not explain whether the update is a full replacement or patch, or what happens to unspecified properties. More behavioral details would improve completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so parameters are well-documented. The description adds meaningful semantics by enforcing that only one of content, name, or type should be passed at a time, which is not evident from the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Updates an API spec's file', providing a specific verb and resource. The constraints (only one property at a time, max size 10MB) further distinguish it from sibling tools like createSpecFile or getSpecFile.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly instructs to 'Only pass one property at a time (content, name, or type)', giving clear usage guidance. It does not explicitly mention when not to use the tool or alternatives, but the constraint provides practical direction.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
updateSpecPropertiesB
Updates an API spec's properties (e.g., name).
| Name | Required | Description | Default |
|---|---|---|---|
| specId | Yes | Spec ID | |
| name | Yes | New spec name |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided; description only states it is an update but does not disclose side effects, authorization needs, or validation behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single sentence with verb and resource front-loaded. No unnecessary words, highly efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Description is minimal; missing return value or success/failure info. However, for a simple two-parameter update, it may be adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and describes both parameters. Description adds minimal value with 'e.g., name' which is already in schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states verb 'Updates' and resource 'API spec's properties' with example 'name'. It distinguishes from sibling tools like createSpec or updateSpecFile.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives. With many spec-related siblings, explicit context or exclusions are missing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
updateWorkspaceA
Updates a workspace property (name, visibility, etc.). Some visibility changes not allowed. Public names must be unique.
| Name | Required | Description | Default |
|---|---|---|---|
| workspaceId | Yes | Workspace ID | |
| workspace | No | Workspace updates |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, description adds some behavioral context (disallowed visibility changes, uniqueness requirement) but lacks detail on side effects, auth needs, or error handling.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences, front-loaded with purpose and constraints, no redundant information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema and nested objects, description covers basic usage but omits explanations of return values, error cases, or comprehensive update behavior.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with descriptions for both parameters. Description adds slight context about updatable fields (name, visibility) but doesn't significantly augment schema meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the action ('Updates') and the target resource ('workspace property'), with specific examples (name, visibility) that distinguish it from sibling tools like createWorkspace or getWorkspace.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides constraints on visibility changes and public name uniqueness, implying when not to use, but does not explicitly compare with alternative tools or specify prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
41 tool updates
v0.1.0- First observed
createCollection - First observed
createCollectionRequest - First observed
createCollectionResponse - First observed
createEnvironment - First observed
createMock - First observed
createSpec - First observed
createSpecFile - First observed
createWorkspace - First observed
duplicateCollection - First observed
generateCollection - First observed
generateSpecFromCollection - First observed
getAllSpecs - First observed
getAuthenticatedUser - First observed
getCollection - First observed
getCollections - First observed
getDuplicateCollectionTaskStatus - First observed
getEnabledTools - First observed
getEnvironment - First observed
getEnvironments - First observed
getGeneratedCollectionSpecs - First observed
getMock - First observed
getMocks - First observed
getSpec - First observed
getSpecCollections - First observed
getSpecDefinition - First observed
getSpecFile - First observed
getSpecFiles - First observed
getTaggedEntities - First observed
getWorkspace - First observed
getWorkspaces - First observed
publishMock - First observed
putCollection - First observed
putEnvironment - First observed
runCollection - First observed
syncCollectionWithSpec - First observed
syncSpecWithCollection - First observed
updateCollectionRequest - First observed
updateMock - First observed
updateSpecFile - First observed
updateSpecProperties - First observed
updateWorkspace
TDQS
Scored across 41 tools
Most tools have distinct purposes, e.g., createCollection vs generateCollection, but some pairs like syncCollectionWithSpec and generateCollection could be confused without careful reading. Overall clear.
All tools use consistent camelCase naming with a clear verb-noun pattern (e.g., createCollection, getEnvironment). No mixing of conventions.
41 tools is on the higher side for an MCP server, but the domain (Postman API) is broad and justifies many operations. However, it slightly exceeds the typical range.
The tool set lacks delete operations for collections, environments, mocks, and specs, creating significant gaps in lifecycle management. Also, collection update is limited to full replacement.
Related MCP Connectors
MCP server for AI access to SmartBear tools, including BugSnag, Reflect, Swagger, PactFlow, QTM4J.
MCP server for AI access to Swagger by SmartBear.
Nifty's MCP server ā exposes tasks, projects, messages, and files as tools for AI agents.
327 dev tools via REST API and MCP. Generate Dockerfiles, schemas, K8s, APIs, and more.