Skip to main content
Glama

sharepoint_read_document

Read-only

Retrieve the content of a bounded SharePoint document by logical alias. Use this tool to read a known document directly, without needing a full file path or graph query.

Instructions

Read one bounded synthetic UTF-8 document by logical alias.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
alias_or_known_itemYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description adds 'synthetic' and 'bounded', which signals it's a test/demo document and possibly limited in scope. It does not describe return format or error behavior, but that is not critical for a read-only tool with a single enum value.

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, tightly-worded sentence with no fluff. It front-loads the action ('Read') and specifies the resource type. Every word contributes to the meaning.

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 tool this simple—one required enum parameter, read-only annotations, no output schema—the description is nearly complete. It could mention that it returns the document content, but the absence is not significant given the trivial scope. The only real omission is guidance on when to use it versus listing, which is covered under usage_guidelines.

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 compensate. It says 'by logical alias', which maps directly to the parameter alias_or_known_item, giving it meaning. However, it does not explain what a 'known_item' is or how the alias format works, though the enum already constrains it to one value.

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 clear action (Read) and a specific resource (one bounded synthetic UTF-8 document by logical alias). It is unambiguous about what the tool does. However, it does not explicitly distinguish itself from the sibling sharepoint_list_folder, though reading vs listing is inherently different.

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?

The description implies usage: when you need to read a document by alias. But it provides no explicit when-to-use or when-not-to-use guidance, and does not mention alternatives like sharepoint_list_folder for browsing. The context is simple enough that this is a minor gap.

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