Update a rule's text - Context7 MCP

patch/v2/teamspaces/{teamspaceId}/rules/{ruleId}

Request example

curl --request PATCH \
  --url https://context7.com/api/v2/teamspaces/{teamspaceId}/rules/{ruleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "<string>",
  "libraryId": "<string>"
}'

import requests

url = "https://context7.com/api/v2/teamspaces/{teamspaceId}/rules/{ruleId}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
payload = {
    "text": "<string>",
    "libraryId": "<string>"
}

response = requests.request("PATCH", url, headers=headers, json=payload)

print(response.text)

const response = await fetch('https://context7.com/api/v2/teamspaces/{teamspaceId}/rules/{ruleId}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "text": "<string>",
    "libraryId": "<string>"
  })
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://context7.com/api/v2/teamspaces/{teamspaceId}/rules/{ruleId}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PATCH',
  CURLOPT_POSTFIELDS => '{
  "text": "<string>",
  "libraryId": "<string>"
}',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
    'Content-Type: application/json',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	url := "https://context7.com/api/v2/teamspaces/{teamspaceId}/rules/{ruleId}"
	payload := strings.NewReader("{\n  \"text\": \"<string>\",\n  \"libraryId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://context7.com/api/v2/teamspaces/{teamspaceId}/rules/{ruleId}"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n  \"text\": \"<string>\",\n  \"libraryId\": \"<string>\"\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://context7.com/api/v2/teamspaces/{teamspaceId}/rules/{ruleId}')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Patch.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{
  "text": "<string>",
  "libraryId": "<string>"
}'

response = http.request(request)
puts response.read_body

Response

{
  "success": true,
  "data": {
    "text": "<string>",
    "createdBy": "<string>",
    "createdAt": 1,
    "libraryType": "repo",
    "docsUrl": "<string>",
    "id": "<string>"
  }
}

{
  "error": "validation_error",
  "message": "Library name is required"
}

{
  "error": "invalid_library_id",
  "message": "Invalid library ID format. Expected: `/owner/repo` for GitHub repositories, or `/<source>/<id>` for other sources (the URL path of the library on context7.com)"
}

{
  "error": "invalid_api_key",
  "message": "Invalid API key. Please check your API key. API keys should start with 'ctx7sk' prefix."
}

{
  "error": "access_denied",
  "message": "Access denied: Library /owner/repo is not included in your allowed libraries"
}

{
  "error": "forbidden",
  "message": "Only team owners and admins can add private repositories"
}

{
  "error": "forbidden",
  "message": "Private repositories require a pro plan or team. Upgrade at https://context7.com/plans"
}

{
  "error": "library_not_found",
  "message": "Library \"/owner/repo\" not found. Please check the library ID or your access permissions."
}

{
  "error": "version_not_found",
  "message": "Version \"canary\" not found for library \"/owner/repo\". Available versions: v2.0.0, v1.5.0"
}

{
  "error": "no_snippets_found",
  "message": "Could not fetch documentation snippets from the library."
}

{
  "error": "no_relevant_snippets",
  "message": "No documentation in \"/owner/repo\" matched this query. Try a more specific query with different terms, or search for another library that covers this topic."
}

{
  "error": "team_not_found",
  "message": "Team not found or access denied"
}

{
  "error": "user_not_found",
  "message": "User not found"
}

{
  "error": "no_libraries_found",
  "message": "No libraries found for \"nonexistent-lib\". Try a different search term."
}

{
  "error": "internal_error",
  "message": "An error occurred while processing your request"
}

patch/v2/teamspaces/{teamspaceId}/rules/{ruleId}

Authorization

Authorizationstringheaderrequired#

Get your API key at context7.com/dashboard. Treat your API key like a password and store it securely.

Path parameters

teamspaceIdstringrequired#

Teamspace id (from GET /v2/teamspaces).

ruleIdstringrequired#

Rule id (a key of global or of libraries[libraryId] in the rule list).

Body

application/json

textstringrequired#

Length: 1–1000

libraryIdstring#

Library id starting with /. Omit or null for a rule on every library.

Responses

application/json

Rule updated

successboolean#

dataobject#

Show child attributes

textstringrequired#

Length: max 1000

createdBystringrequired#

User id of the author.

createdAtintegerrequired#

Unix time in milliseconds.

libraryTypeenum<string>#

Options:repollmstxtwebsiteopenapipdfdocxfileconfluencenotion

docsUrlstring#

idstring#

Returned on create only.

Delete a rule Get library policies