Skip to main content
Glama

init_project

Initializes a workspace for swagger-mcp by creating .swagger-mcp/config.json and cache directory, enabling offline Swagger/OpenAPI search.

Instructions

Create .swagger-mcp/config.json and cache directory in the requested workspace.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceYesAbsolute path to the business project that owns .swagger-mcp.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full disclosure burden. It does name the concrete side effects (creating a config file and a cache directory), which is meaningful behavioral detail. However, it is silent on critical traits: whether it overwrites an existing config, whether it is idempotent, whether it fails when the directory already exists, and what permissions it needs.

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?

A single sentence with no filler that front-loads the created artifacts and ends with the target location. Every clause earns its place.

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?

For a one-parameter setup tool with no annotations, no output schema, and full schema coverage, the description is adequate for the mechanical action. It is incomplete on the behavioral questions that matter for an initializer (idempotency, overwrite semantics, failure modes), leaving the agent to guess about re-running it.

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 single 'workspace' parameter is already fully documented as an absolute path owning .swagger-mcp. The description only echoes this ('in the requested workspace') and adds no format or validation nuance beyond the schema, so the baseline 3 applies.

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

Purpose4/5

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

The description states a concrete verb (Create) and the exact artifacts produced (.swagger-mcp/config.json and a cache directory) in the workspace. This is specific enough to distinguish it from the service/operation-management siblings, none of which perform setup. It falls just short of a 5 because it doesn't frame the tool's role in the overall workflow (e.g., first-run bootstrap).

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

Usage Guidelines2/5

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

There is no guidance on when to invoke this tool, no prerequisite or ordering information (e.g., 'run before add_service'), and no statement about when it should not be used. The agent must infer that this is a one-time setup step from the name alone.

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