Skip to main content
Glama
Beltran12138

wecom-docs-mcp-server

by Beltran12138

wecom-docs-mcp-server

⚠️ Archivado 2026-08-18 — lea esto primero

Sin mantenimiento y nunca publicado en PyPI. La línea pip install wecom-docs-mcp-server que aparece más abajo no funciona y nunca funcionó: instale desde el código fuente si aún quiere ejecutarlo.

Por qué está archivado

Este servidor es un proxy stdio sobre el backend robot-doc MCP de WeCom. La inversión de Tencent se ha movido visiblemente a otra superficie: el oficial WecomTeam/wecom-cli (Rust; reescrito para v1.1.0 el 2026-08-17, 14 dominios de servicio) más la habilidad de agente oficial WecomTeam/wecom-unified. El backend robot-doc MCP no ha tenido actualizaciones públicas desde el 2026-04-22.

Lo que ahora cubre el CLI oficial

Verificado contra @wecom/cli v1.1.0 el 2026-08-18:

Punto de venta de este proyecto

Estado en v1.1.0

transporte stdio

Obsoleto — el CLI es un proceso local. Cualquier agente que pueda ejecutar un shell no necesita ninguna capa MCP.

ms-epoch → ISO 8601

Obsoleto — el CLI devuelve 2026-08-17 12:17:25 directamente.

sugerencias de error en chino

Obsoleto — el CLI devuelve help_message + help_instruction, incluyendo un enlace clicable de reparación de autorización.

Paso de esquema

Obsoleto — cada subcomando acepta --schema (esquema JSON completo con descripciones de campos) y --doc.

Desenvolvimiento de celdas de Smartsheet

Aún sin resolver. v1.1.0 todavía devuelve values[field] = [{"type":"text","text":...}], y las celdas largas de texto enriquecido se fragmentan en docenas de segmentos.

Si vino aquí para dar a un agente acceso a documentos de WeCom

Use el CLI oficial, no este:

npm install -g @wecom/cli
npx skills add WecomTeam/wecom-unified -y -g
wecom-cli auth init

La única parte que aún vale la pena copiar

wecom_doc_mcp/transforms.py — la transformación de desenvolvimiento de celdas. ~120 líneas, sin dependencia de MCP. Tómela como un filtro de post-procesamiento en la salida del CLI en lugar de ejecutar este servidor.

Dos hallazgos empíricos que vale la pena conservar

Observado en 2026-07 contra el backend robot-doc:

  • get_doc_content y smartsheet_get_* usan ámbitos de permiso independientes. El mismo bot puede leer una smartsheet mediante smartsheet_get_records (errcode 0) y aún así obtener 851003 no authority de get_doc_content en ese mismo documento. Enrute las lecturas por tipo de documento; un ámbito que funcione no prueba nada sobre el otro.

  • Pase la url completa del documento, incluido ?scode= en lugar de reconstruir docid. El backend resuelve la URL; quitar prefijos manualmente produce 301085 invalid docid.


MCP Python License: MIT Tests

Una fachada MCP stdio ergonómica sobre el backend robot-doc MCP oficial de WeCom. Hace de proxy de las 25 herramientas del backend tal cual y añade una capa de transformación que hace que la salida cruda sea utilizable por agentes LLM:

  • Paso de esquema — la lista de herramientas se obtiene del backend al inicio, por lo que sigue automáticamente las actualizaciones oficiales. Cero mantenimiento de esquema.

  • Desenvolvimiento de celdas — las celdas de smartsheet values[field] = [{"type":"text","text":...}] se convierten en escalares simples (en una vista _rows).

  • ms → ISO — las marcas de tiempo de 13 dígitos en ms-epoch (create_time, update_time) se convierten a ISO 8601.

  • Sugerencias de error en chino — errcode 851003 etc. reciben _error_summary + _error_hint para que el agente aprenda la solución, no solo el código.

Relación con el backend: Este servidor requiere el backend oficial robot-doc MCP (una apikey de WeCom admin → 智能文档机器人 → API). Es una capa delgada de proxy + ergonomía, no un reemplazo.


Related MCP server: google-suite-mcp

Por qué existe esto

El backend oficial robot-doc es un servidor MCP HTTP (StreamableHttp). Dos puntos de fricción: (1) muchos clientes MCP y flujos de trabajo de desarrollo prefieren stdio; (2) su salida cruda es hostil para agentes — formato de celdas anidado, cadenas ms-epoch, códigos de error opacos. Este servidor une ambos:

robot-doc oficial

este servidor

Transporte

HTTP (StreamableHttp)

stdio

Esquema de herramientas

25 herramientas crudas

mismas 25, paso directo

Formato de celdas

[{"type":"text",...}]

escalares desenvolvidos (_rows)

Marcas de tiempo

cadenas ms-epoch

ISO 8601

Códigos de error

851003 solo

+ resumen en chino + sugerencia de solución

apikey

requerida

requerida (proxy)


Requisitos

  • Python 3.9+

  • Un 智能文档机器人 (Smart Doc Bot) de WeCom con su clave API — disponible para empresas (≥10 miembros) a través de WeCom admin → 应用管理 → 智能文档机器人 → API.


Instalación

⚠️ Nunca publicado en PyPI. pip install wecom-docs-mcp-server devuelve 404. La instalación desde el código fuente es la única vía.

Clonar + editable:

git clone https://github.com/Beltran12138/wecom-docs-mcp-server
cd wecom-docs-mcp-server
pip install -e .

Configuración

Variable

Requerida

Descripción

WECOM_MCP_APIKEY

sí

apikey de robot-doc

WECOM_MCP_BASE_URL

no

sobrescribir URL del backend (por defecto https://qyapi.weixin.qq.com/mcp/robot-doc)

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "wecom-doc": {
      "command": "wecom-docs-mcp-server",
      "env": { "WECOM_MCP_APIKEY": "your_apikey_here" }
    }
  }
}

Herramientas

Todas las 25 herramientas del backend se exponen tal cual (obtenidas en vivo al inicio). Por dominio:

Dominio

Lectura

Escritura

doc

get_doc_content

create_doc, edit_doc_content, upload_doc_image, upload_doc_file

smartsheet (智能表)

get_sheet, get_fields, get_records

add/update/delete × sheet/fields/records

sheet (电子表格)

get_info

add_sub, delete_sub, update_range_data, append_data

smartpage (智能页面)

get_export_result

create, export_task

Modelo de permisos (observado empíricamente en 2026-07): get_doc_content y smartsheet_get_* usan ámbitos de permiso independientes. Un bot puede leer una smartsheet mediante smartsheet_get_records (errcode 0) y aún así obtener 851003 no authority de get_doc_content en el mismo documento. Enrute las lecturas por tipo de documento.


Transformaciones (el valor añadido)

Se aplican automáticamente en cada respuesta de tools/call:

  1. _rows en smartsheet_get_records — una vista aplanada donde las celdas se desenvolvuelven a escalares y los campos de registro de nivel superior (record_id, create_time, …) se conservan. El array original records se mantiene intacto.

  2. ms → ISO en todas las cargas útiles de dictado exitosas — cadenas de 13 dígitos en ms-epoch → ISO 8601. Los IDs alfanuméricos (q979lj) no se tocan.

  3. _error_summary + _error_hint en cualquier errcode distinto de cero — explicación en chino + solución concreta.


Uso

Lea una smartsheet de principio a fin:

User: read https://doc.weixin.qq.com/smartsheet/s3_xxx?scode=yyy

Agent:
1. smartsheet_get_sheet(url=...)          → sheet_id (e.g. "q979lj")
2. smartsheet_get_fields(sheet_id, url)   → field schema (types, IDs)
3. smartsheet_get_records(sheet_id, url)  → records + _rows (cells unwrapped, timestamps ISO)

Pase la url completa (con ?scode=) en lugar de adivinar docid — el backend la resuelve. Extraer manualmente el docid quitando prefijos es propenso a errores (empíricamente: 301085 invalid docid).


Solución de problemas

errcode

significado

solución

851000

error en el enlace del documento

comprobar url + scode, o usar docid

851002

tipo de documento incompatible con la herramienta

smartsheet → usar smartsheet_get_*

851003

sin permiso de documento

para smartsheet usar smartsheet_get_*; para documentos normales revisar permisos en el panel

851008

falta permiso de lectura de contenido del documento

panel de WeCom → robot → permisos de API

301085

docid no válido

usar url completa con scode

40058

faltan parámetros

smartsheet necesita sheet_id (primero get_sheet)


Relacionados

Proyecto

Enfoque

robot-doc MCP oficial

backend (HTTP, empresas con ≥10 miembros)

wecom-bot-mcp-server

mensajería de bot vía webhook

este servidor

proxy stdio de robot-doc + ergonomía


Pruebas

pip install -e ".[dev]"  # or: pip install pytest httpx
pytest

25 pruebas unitarias cubren el análisis SSE/JSON, la normalización de marcas de tiempo ms, el desenvolvimiento de celdas, la humanización de errores y el enrutamiento/post-procesamiento del servidor — todo sin conexión (httpx simulado).


Licencia

MIT

Available Tools

9 tools
wecom_create_docA

Create a new WeCom document or smartsheet. Returns url and docid — save the docid for subsequent edits.

ParametersJSON Schema
NameRequiredDescriptionDefault
doc_nameYesDocument name (max 255 chars)
doc_typeYes3 = regular document, 10 = smartsheet

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are provided, so the description must disclose behavioral traits. It indicates the tool is a create operation (non-destructive) and provides essential output info. However, it does not mention any side effects, auth requirements, or error conditions, which is a gap given the lack of annotations.

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, concise sentence that communicates purpose and key output. It is front-loaded with the action and resource.

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?

Given the tool is simple with two required params, no nested objects, and no output schema, the description covers the creation purpose and output. However, it lacks workflow guidance (e.g., how to use docid with sibling tools) and does not explain return format details.

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 schema already documents both parameters. The description adds that docid is for subsequent edits, but does not elaborate on the meaning of doc_name or doc_type beyond the schema. A score of 3 is appropriate as per guidelines.

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 the tool creates a new WeCom document or smartsheet, specifying the two types via doc_type. It distinguishes this from siblings like wecom_edit_doc and wecom_read_doc by using the verb 'create' and mentioning the output (url and docid).

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

Usage Guidelines4/5

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

The description implies usage for creation tasks and instructs to save the docid for subsequent edits, suggesting a common workflow. However, it does not explicitly state when not to use this tool or compare with alternatives such as wecom_edit_doc for modifications.

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

wecom_edit_docB

Write Markdown content to a WeCom document. Supports headings, lists, tables, bold, italic. Use docid (preferred) or url to identify the document.

ParametersJSON Schema
NameRequiredDescriptionDefault
contentYesMarkdown content to write
docidNoDocument docid from wecom_create_doc (preferred)
urlNoDocument URL (fallback if docid unavailable)

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states the tool writes content but does not disclose if the operation is destructive (overwrites vs appends), whether it requires special permissions, or what happens if the document does not exist. This is a significant gap for a mutation tool.

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?

Two sentences, no filler. The first sentence states the action, the second provides necessary detail on supported syntax and identification methods. Efficient and clear.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema and no annotations, the description could benefit from mentioning return behavior (e.g., success confirmation, errors). The tool has 3 params, one required, and current description covers identification but not the write behavior (overwrite vs append) or effects on existing content.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and description adds value by explaining that 'docid' is preferred and 'url' is a fallback, which clarifies their relative importance beyond the schema descriptions.

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 clearly states the verb 'Write' and resource 'Markdown content to a WeCom document', and lists supported syntax (headings, lists, tables, bold, italic). However, it does not explicitly distinguish itself from sibling tools like wecom_read_doc or wecom_get_doc_content, though the action is 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 mentions using docid (preferred) or url to identify the document, which gives some guidance. But it does not explain when to use this tool over alternatives, e.g., when to edit vs create (wecom_create_doc) or read (wecom_read_doc).

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

wecom_get_doc_contentA

Fetch the full content of a WeCom online doc as Markdown. Uses async polling internally.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYesDocument URL
task_idNoPolling task_id (omit on first call)

TDQS

A4/5.0
Behavior4/5

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

The description mentions 'Uses async polling internally', disclosing behavioral trait beyond what the schema provides (which only lists parameters). Without annotations, this is valuable. It also implies the tool may return partial results initially.

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?

Two sentences, concise and front-loaded with the purpose. The second sentence adds behavioral context. No waste.

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?

Given no output schema and no annotations, the description could be improved by mentioning the return format (Markdown) and any limits. However, it covers the main purpose and polling nature adequately.

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%, so the schema already documents both parameters. The description adds that task_id is for polling and implies it should be omitted on first call, but this is already in the schema description. So baseline 3.

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 'Fetch the full content of a WeCom online doc as Markdown', which is a specific verb ('Fetch') and resource ('WeCom online doc'). It also distinguishes from siblings like wecom_read_doc likely by focusing on full content and Markdown format.

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

Usage Guidelines4/5

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

The description says 'Uses async polling internally', which implies it is for getting full content and may require an initial call with just url and then polling with task_id. However, it does not explicitly state when to use this vs siblings or when not to use it.

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

wecom_read_docA

Read a WeCom document or smartsheet. Returns content as Markdown. Auto-detects URL type: /smartsheet/ URLs return table data, /doc/ URLs return document content.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYesFull WeCom doc or smartsheet URL (include scode param if present)

TDQS

A4.4/5.0
Behavior4/5

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

No annotations provided; the description carries full burden. It discloses auto-detection of URL type and return format (Markdown). However, it does not mention potential errors, rate limits, or whether authentication is needed. Still, for a read tool, this is adequate.

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?

Three sentences, all essential. No fluff, front-loaded with purpose, then adss specific behavior about return format and URL auto-detection.

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?

Given only one parameter, no output schema, and no annotations, the description is relatively complete. It explains input, behavior, and output. Could mention pagination or limitations for large docs, but overall sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% (the url parameter is described). The description adds meaning beyond the schema by explaining what URLs are accepted and how they are processed (auto-detect). It could be more precise about the scode parameter, but minimal.

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 the tool reads a WeCom document or smartsheet and returns content as Markdown. It distinguishes itself from siblings (e.g., wecom_get_doc_content, wecom_smartsheet_get_records) by focusing on reading with Markdown output and URL auto-detection.

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

Usage Guidelines4/5

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

The description does not explicitly state when not to use this tool vs. siblings, but it does provide context on URL types (smartsheet vs. doc) and what to expect. Implicitly, if the user wants raw data or specific fields, other tools might be better, but this is not stated.

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

wecom_smartsheet_add_recordsA

Append rows to a smartsheet. Each record is a plain {column_name: value} dict — cell format conversion is handled automatically.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlNoSmartsheet URL
docidNoSmartsheet docid
sheet_idYesSheet ID
recordsYesList of {column_name: value} objects

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are provided, so the description bears full burden. It correctly states mutation ('Append rows') but does not disclose potential side effects, error behaviors (e.g., row limit, duplicate handling), or authentication requirements. The automatic format conversion is mentioned, which is a behavioral trait, but more could be said.

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 two sentences: first defines purpose, second clarifies input format. No wasted words. Could be slightly more structured (e.g., bullet points for prerequisites), but it is efficient and front-loaded.

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?

Given the tool's moderate complexity (4 parameters, no output schema, no annotations), the description covers the key action and input format but lacks details on error cases, rate limits, or what happens on success. It is adequate but not comprehensive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so parameters are described in the schema. The description adds value by explaining the records parameter format ('plain dict') and that cell conversion is automatic, which is not in the schema. The other parameters (url, docid, sheet_id) are already clear from schema descriptions.

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 the action ('Append rows to a smartsheet') and the input format ('Each record is a plain {column_name: value} dict'). It distinguishes from sibling tools like wecom_smartsheet_get_records (read) and wecom_smartsheet_setup_fields (schema setup). The scope of operation is explicit.

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 use when you need to add data to an existing smartsheet, but does not explicitly state when not to use it (e.g., for creating new sheets or updating existing records) or mention alternatives among siblings. It provides no prerequisites or context about required identifiers.

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

wecom_smartsheet_get_fieldsA

Get column definitions (field names, types, IDs) for a smartsheet sheet.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYesSmartsheet URL
sheet_idYesSheet ID

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are provided, so the description bears full burden. It correctly states 'Get column definitions', indicating a read operation. However, it does not disclose any behavioral traits such as pagination, performance, or authentication requirements.

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?

Single sentence, front-loaded with the action and resource. No unnecessary words.

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?

Given the simple nature and good schema coverage, the description is adequate but could include what happens if a sheet doesn't exist or if parameters are invalid.

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% and the schema already provides descriptions. The description adds no extra meaning beyond what the schema gives.

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 starts with the verb 'Get' and specifies the resource 'column definitions for a smartsheet sheet', clearly distinguishing it from siblings like wecom_smartsheet_add_records and wecom_smartsheet_get_records. It also lists the content: field names, types, IDs.

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?

No guidance on when to use this tool vs alternatives (e.g., wecom_smartsheet_get_sheet or wecom_smartsheet_setup_fields). The description implies it is for reading metadata, but does not explicitly state when to choose this over other sheet-related tools.

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

wecom_smartsheet_get_recordsC

Fetch all rows from a smartsheet sheet. Returns structured row data.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYesSmartsheet URL
sheet_idYesSheet ID

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries full burden. It lacks details on read-only nature, pagination, authorization requirements, or rate limits. The word 'Fetch' implies read, but no explicit safety guarantee.

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?

Short and to the point with two sentences. No redundant information, but could be improved by front-loading the core action more clearly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema and no annotations, the description is incomplete. It doesn't explain what 'structured row data' includes, how errors are handled, or whether results are paginated. For a fetch operation, return format is crucial.

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% with both parameters having descriptions. However, the description adds no extra meaning beyond the schema—no format or usage hints for url or sheet_id.

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 clearly states 'Fetch all rows from a smartsheet sheet' with the verb 'Fetch' and resource 'rows from a smartsheet sheet', and distinctively mentions 'all rows' versus sibling tools like 'wecom_smartsheet_get_fields' which fetches fields.

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?

No guidance on when to use this tool versus siblings like 'wecom_smartsheet_get_sheet' (which likely returns sheet metadata) or 'wecom_smartsheet_add_records'. The description only says what it does, not when to prefer it.

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

wecom_smartsheet_get_sheetA

List all sheets (sub-tables) in a WeCom smartsheet. Returns sheet IDs and titles.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYesSmartsheet URL

TDQS

A3.5/5.0
Behavior3/5

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

The description discloses that it returns IDs and titles, which is helpful. Since no annotations are provided, the description carries the full transparency burden. It lacks detail about potential side effects (none expected for a list operation), permissions, or pagination. But it correctly implies a read-only operation.

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 that is concise and directly states the tool's purpose and return value. No superfluous words; it 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 simple listing tool with one parameter and no output schema, the description is adequate but minimal. It doesn't explain the format of the return (e.g., whether it's a list of objects) or any limitations. It lacks contextual completeness about potential errors or prerequisites.

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 one parameter 'url' having a description 'Smartsheet URL'. The description does not add new meaning beyond the schema; it just reiterates that it lists sheets. With high schema coverage, the baseline is 3, and there is no extra parameter context added.

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 clearly states the tool's purpose: listing sheets in a WeCom smartsheet and returning their IDs and titles. It uses the specific verb 'list' and identifies the resource (sheets/sub-tables). However, it does not differentiate this tool from siblings like wecom_smartsheet_get_fields or wecom_smartsheet_get_records, which might list other entities.

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 when to use this tool: when you need to discover available sheets and their IDs. However, it does not provide explicit guidance on when not to use it or mention alternatives like wecom_smartsheet_get_fields for columns or wecom_smartsheet_get_records for data.

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

wecom_smartsheet_setup_fieldsA

Initialize a smartsheet's column schema. Renames the default field and adds remaining fields. Must be called before adding records to a new sheet.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlNoSmartsheet URL (or use docid)
docidNoSmartsheet docid (or use url)
sheet_idYesSheet ID from wecom_smartsheet_get_sheet
field_namesYesColumn names in order

TDQS

A3.7/5.0
Behavior3/5

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

The description indicates it renames the default field and adds fields, hinting at destructive or setup behavior. However, no annotations are provided, so the description carries the full burden. It lacks details on reversibility, idempotency, or what happens if called on an already-initialized sheet, which is a gap for a setup action.

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 extremely concise: two sentences that cover purpose, action, and prerequisite. No wasted words.

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?

Given 4 parameters (2 required) and no output schema, the description provides basic setup context but omits details like what the default field is renamed to, error handling, or return value. The note about ordering is helpful but not comprehensive.

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 schema already documents all parameters. The description does not add meaning beyond the schema; 'field_names' purpose is clear from context. Baseline 3 is appropriate.

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 clearly states the tool initializes a smartsheet's column schema by renaming the default field and adding remaining fields. The verb 'Initialize' and resource 'column schema' are specific, and the setup nature distinguishes it from read/record siblings.

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

Usage Guidelines4/5

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

The description explicitly states the tool must be called before adding records to a new sheet, giving clear temporal guidance. However, it does not mention when not to use this tool versus alternatives like wecom_smartsheet_get_fields, so it is not a full 5.

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

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 9 tool updatesv1.0.0
    • First observedwecom_create_doc
    • First observedwecom_edit_doc
    • First observedwecom_get_doc_content
    • First observedwecom_read_doc
    • First observedwecom_smartsheet_add_records
    • First observedwecom_smartsheet_get_fields
    • First observedwecom_smartsheet_get_records
    • First observedwecom_smartsheet_get_sheet
    • First observedwecom_smartsheet_setup_fields

TDQS

A3.7/5.0

Scored across 9 tools

Disambiguation4/5

Tools are mostly distinct: docs (create, edit, get, read) vs smartsheets (add_records, get_fields, get_records, get_sheet, setup_fields). However, wecom_get_doc_content and wecom_read_doc overlap in purpose (both fetch content), though read auto-detects smartsheets, creating slight ambiguity.

Naming Consistency4/5

All tools follow wecom_verb_noun pattern, but verbs vary (create, edit, get, read, add, setup). Consistent snake_case and prefix, but 'get' vs 'read' for similar operations is a minor inconsistency.

Tool Count5/5

With 9 tools covering document and smartsheet operations, the count is well-scoped. Each tool serves a clear purpose without redundancy, appropriate for the domain.

Completeness4/5

Covers core CRUD for docs (create, edit, read) and smartsheets (schema, records, sheets). Missing delete/update for smartsheets or document deletion, but essential workflows are complete, so minor gaps.

Maintenance

ActivitySlowing
ResponsivenessUnresponsive

Related MCP Connectors

Related MCP Servers

  • -
    license
    Not graded
    quality
    Not graded
    maintenance
    A tool designed to help users connect AI Agents with the Feishu/Lark platform, encapsulating Feishu/Lark Open Platform API interfaces as MCP tools for document processing, conversation management, calendar scheduling and more.
    6,381 npm
    -
  • A
    license
    Not graded
    quality
    D
    maintenance
    This is the Feishu/Lark official OpenAPI MCP (Model Context Protocol) tool designed to help users quickly connect to the Feishu/Lark platform and enable efficient collaboration between AI Agents and Feishu/Lark. The tool encapsulates Feishu/Lark Open Platform API interfaces as MCP tools, allowing AI assistants to directly call these interfaces and implement various automation scenarios such as document processing, conversation management, calendar scheduling, and more.
    6,381 npm
    MIT