Skip to main content
Glama

Open Workspace

open_workspace
Read-only

Open a local project directory as a workspace, returning its ID, git status, skills, and compact file tree for immediate coding agent context.

Instructions

Open a local project directory as a CodexPro workspace. Returns a workspace_id plus git status, AGENTS.md, skills, and a compact file tree.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoAlias for root. Useful for clients that naturally send path instead of root.
rootNoProject directory to open. Omit to use CODEXPRO_ROOT/current working directory. Supports ~/ paths.
max_depthNoTree depth. Default: 3.
max_filesNoAlias for maximum tree entries. Default: 500.
include_treeNoInclude a compact file tree. Default: true.
include_skillsNoDiscover workspace, user, and plugin skills by name/description. Default: true.
bootstrap_contextNoDeprecated and ignored. Use handoff_to_agent to create .ai-bridge files.
include_global_skillsNoAlso scan installed user/plugin skills when include_skills=true. Default: true.
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, signaling a non-mutating operation. The description adds return-value context (workspace_id, git status, skills) but no additional behavioral traits such as authentication needs, rate limits, or potential side effects beyond what annotations already cover. It neither contradicts annotations nor introduces new behavioral caveats.

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 sentence, front-loaded with the action ('Open') and followed by a concise list of return items. It is free of filler, repetition, or unnecessary details, making it immediately scannable and efficient.

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 tool with 8 parameters and no output schema, the description is minimal but adequate: it conveys the core purpose and return data. Parameter details are fully covered by the schema, so the description doesn't need to repeat them. However, it omits any guidance on parameter interactions or defaults, which could be useful for an agent deciding how to invoke the tool. A slightly richer description could mention that omitting root uses the current directory and that several flags control tree and skill inclusion.

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?

All 8 parameters are fully described in the input schema (100% coverage), and the description adds no parameter-specific meaning beyond that. The description simply names the operation; the schema already explains each parameter's purpose, defaults, and constraints. Baseline 3 applies because the schema carries the full semantic load.

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 states a specific verb ('Open') and a precise resource ('a local project directory as a CodexPro workspace'), and lists the exact return content (workspace_id, git status, AGENTS.md, skills, compact file tree). This clearly distinguishes it from the sibling open_current_workspace, which targets the current directory rather than a specified path.

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?

The description does not explicitly state when to use this tool versus alternatives. While the sibling open_current_workspace suggests a complementary use case, the description provides no direct comparison, conditions, or when-not-to-use guidance. The intent is only implied by the name and schema.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

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

curl -X GET 'https://glama.ai/api/mcp/v1/servers/sedatustunova/S3dat-Relay'

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