Skip to main content
Glama

Resolve a relative document link

bpj_resolve_relative_document_link
Read-onlyIdempotent

Resolve a link against its source document to get a repository-relative path and preserve the query or fragment.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "source": "<source>",
      "target": "<target>"
    },
    "name": "bpj_resolve_relative_document_link"
  }
}

Input Schema

NameRequiredDescriptionDefault
sourceYes
targetYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare the tool as read-only, idempotent, non-destructive, and closed-world, covering the safety profile. The description adds that the result is a repository-relative path and that query/fragment components are preserved, which is useful output behavior, but it does not describe error handling or behavior for absolute or malformed links.

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, front-loaded sentence with no redundant wording. It efficiently conveys the operation and the key output guarantee.

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 two-parameter utility with annotations covering safety, the description gives enough to understand the operation and expected result. Some edge-case behavior and parameter format details are missing, but the core usage is clear.

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 0%, so the description must add parameter meaning. It implies that "source" is the base document and "target" is the link to resolve, and it clarifies the resulting path treatment. However, it does not explain path formats, how the source path is used as a base, or constraints beyond the schema's maxLength.

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 specific verb ("Resolve") and resource ("relative document link") plus the outcome ("repository-relative path"), making the operation clear. It does not explicitly differentiate this from sibling link-checking tools, so it falls short of a 5.

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 explains what the tool does but gives no when-to-use guidance, prerequisites, or alternatives. An agent can infer it is for resolving relative links, but there is no explicit routing information.

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.