Skip to main content
Glama

포트원 문서 목록 조회

listPortoneDocs

Retrieve a tree list of PortOne documentation under specified paths, showing document paths, titles, descriptions, and target versions.

Instructions

특정 경로 하위에 있는 모든 포트원 문서 목록을 트리 형태로 조회합니다. 목록에는 문서 경로, 제목, 설명, 대상 버전 등 축약된 문서 정보가 포함되어 있습니다.

Returns: 필터링된 문서 목록 (각 문서의 파일명, 길이, 제목, 설명, 대상 버전 등)

Note: 문서 목록은 대량의 데이터이므로 상위 디렉토리를 조회할 경우 omitFiles를 true로 설정합니다.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathsNo하위 목록을 조회할 경로들입니다. 미입력 시 전체 목록을 조회합니다.
onlyPathsNotrue인 경우 문서를 제외한 디렉토리 목록만 표시하고, 디렉토리 하위에 readme.md가 있는 경우 해당 파일의 설명을 표시합니다.
Behavior3/5

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

The description mentions tree form and returned fields, but does not disclose read-only nature, authentication, side effects, or rate limits. With no annotations, the description carries the burden but only partially fulfills it.

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

Conciseness4/5

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

The description is concise with three sentences, but the note about omitFiles adds unnecessary confusion and could be omitted.

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 simple listing tool with no output schema, the description covers purpose, output fields, and an operational note. The inconsistency in the note slightly reduces completeness.

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 coverage is 100% with detailed parameter descriptions. The tool description adds little beyond the schema; the note about omitFiles is inconsistent with the actual parameters.

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 it retrieves all PortOne documents under a specific path in tree form, distinguishing it from sibling tools that focus on URLs, single documents, schemas, or search.

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

Usage Guidelines3/5

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

Usage is implied for listing documents, but there is no explicit guidance on when to use this tool versus alternatives. The note about omitFiles is confusing as the parameter does not exist in the 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/portone-io/mcp-server'

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