Skip to main content
Glama
alpacahq

alpaca-mcp-server

Official
by alpacahq

create_locate

Create a locate request for a short sale by specifying a stock symbol and quantity, with optional limit price and all-or-none flag.

Instructions

Creates a locate request for a short sale. Requires a symbol and quantity. Optionally set a limit price and all-or-none flag.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qtyYesNumber of shares to locate. Must be positive and in round lots of 100; invalid quantities return HTTP 400.
symbolYesStock symbol.
all_or_noneNoReject the locate unless the full requested quantity is available.
limit_priceNoMaximum acceptable locate fee per share, as a decimal string in USD. If omitted, any quoted fee is accepted.
Idempotency-KeyNoOptional idempotency key for safe retries. Reusing the same key with the same request returns the original locate response. Reusing the same key with a different request returns HTTP 422. We recommend always providing this header in production so timeouts, network errors, and 5xx responses can be safely retried without creating duplicate locates. Use a client-generated unique value, such as a UUID, for each logical locate.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.3.2

TDQS

A3.7/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states that the tool creates a locate request, but does not disclose idempotency behavior, error conditions, side effects on locate inventory, or what happens when quantity or all-or-none constraints are violated. For a mutating operation without annotations, this is a meaningful gap.

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

Conciseness5/5

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

The description is a single tight, front-loaded sentence that states the action, the domain, the required inputs, and the optional inputs with no wasted words. It earns its place entirely.

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

Completeness3/5

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

With an output schema and fully described input properties, the description is minimally adequate for basic invocation. However, it omits guidance about the recommended Idempotency-Key usage and does not distinguish when to use this creation tool versus related locate-reading or locate-quote tools, leaving some context to be inferred.

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

Parameters3/5

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 symbol, qty, all_or_none, limit_price, and Idempotency-Key. The description adds only a high-level restatement of required and optional parameters, and it uses 'limit price' without clarifying that this refers to the locate fee rather than a stock price, which the schema does explain.

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

Purpose5/5

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

The description names a specific verb and resource: it creates a locate request for a short sale. It clearly distinguishes this creation action from sibling tools like get_locate, get_locate_quotes, and get_locates, which read locate data rather than create it.

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

Usage Guidelines4/5

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

The description gives clear context for use: creating a locate request for a short sale, requires symbol and quantity, with optional limit price and all-or-none flag. It does not explicitly name alternatives or exclusions, but the create-versus-read distinction from the sibling list makes the appropriate use clear.

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

Deploy Server

Other Tools