Skip to main content
Glama

Publish a project

ship_project

Publish a new project to Shipyard under your account. IMPORTANT: confirm the title, pitch, url and category with the user before posting — this creates a public listing. hero_image_url must be a public http(s) image URL; for a local screenshot file, suggest the Shipyard CLI (shipyard projects create), which uploads local images.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesPublic http(s) URL where people can try it.
pitchYesOne-line pitch (what it is, who it's for).
titleYesProject name.
body_mdNoOptional longer description (markdown).
categoryYesBest-fit category.
repo_urlNoOptional http(s) source-repo URL.
hero_image_urlNoOptional public http(s) hero image URL.

TDQS

A4.4/5.0
Behavior4/5

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

Annotations indicate a non-read-only, non-idempotent write operation. The description adds that it creates a public listing (warning the agent of visibility) and specifies constraints for hero_image_url (must be public http(s) URL). No contradiction with annotations.

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?

Two sentences, no unnecessary words. The purpose and critical usage warning are front-loaded. Every sentence earns its place.

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

Completeness4/5

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

For a 7-parameter tool with no output schema, the description covers the main functionality, critical pre-conditions, and a key parameter constraint. It lacks details about the return value or success/failure behavior, but the essentials for invocation are present.

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

Parameters4/5

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

Schema coverage is 100%, but the description adds value by emphasizing the need for user confirmation on the required parameters and explaining the hero_image_url constraint in detail, including a workaround for local files. This goes beyond the schema's basic descriptions.

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 clearly states the tool publishes a new project under the user's account. It specifies the action ('Publish') and resource ('project'), and the IMPORTANT note distinguishes this as a creation tool from sibling tools like 'get_project' or 'list_projects'.

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?

Explicitly instructs the agent to confirm title, pitch, url, and category with the user before posting, emphasizing the public nature of the listing. It also advises using the CLI for local images, providing clear context. While it doesn't explicitly list when not to use, the sibling context offers alternatives.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.2/5.0
Disambiguation5/5

Every tool has a clear, distinct purpose: project CRUD, reviews, likes, bounties, and wallet. No overlap in functionality.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case, making them predictable and easy to understand.

Tool Count5/5

8 tools cover the essential actions for a project review platform without being excessive or insufficient.

Completeness4/5

Core operations are present, but missing update and delete for projects and reviews, which are minor gaps agents can work around.

Resources